Package com.ibm.fhir.model.resource

Class CapabilityStatement.Rest

java.lang.Object

com.ibm.fhir.model.visitor.AbstractVisitable

com.ibm.fhir.model.type.Element

com.ibm.fhir.model.type.BackboneElement

com.ibm.fhir.model.resource.CapabilityStatement.Rest

All Implemented Interfaces:

Visitable

Enclosing class:

CapabilityStatement

public static class CapabilityStatement.Rest
extends BackboneElement

A definition of the restful capabilities of the solution, if any.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	CapabilityStatement.Rest.Builder
static class	CapabilityStatement.Rest.Interaction	A specification of restful operations supported by the system.
static class	CapabilityStatement.Rest.Resource	A specification of the restful capabilities of the solution for a specific resource type.
static class	CapabilityStatement.Rest.Security	Information about security implementation from an interface perspective - what a client needs to know.

Field Summary

Fields inherited from class com.ibm.fhir.model.type.BackboneElement

modifierExtension

Fields inherited from class com.ibm.fhir.model.type.Element

extension, hashCode, id

Method Summary

Modifier and Type	Method	Description
void	accept(String elementName, int elementIndex, Visitor visitor)	Accept a Visitor and invoke the appropriate visit methods.
static CapabilityStatement.Rest.Builder	builder()
boolean	equals(Object obj)
List<Canonical>	getCompartment()	An absolute URI which is a reference to the definition of a compartment that the system supports.
Markdown	getDocumentation()	Information about the system's restful capabilities that apply across all applications, such as security.
List<CapabilityStatement.Rest.Interaction>	getInteraction()	A specification of restful operations supported by the system.
RestfulCapabilityMode	getMode()	Identifies whether this portion of the statement is describing the ability to initiate or receive restful operations.
List<CapabilityStatement.Rest.Resource.Operation>	getOperation()	Definition of an operation or a named query together with its parameters and their meaning and type.
List<CapabilityStatement.Rest.Resource>	getResource()	A specification of the restful capabilities of the solution for a specific resource type.
List<CapabilityStatement.Rest.Resource.SearchParam>	getSearchParam()	Search parameters that are supported for searching all resources for implementations to support and/or make use of - either references to ones defined in the specification, or additional ones defined for/by the implementation.
CapabilityStatement.Rest.Security	getSecurity()	Information about security implementation from an interface perspective - what a client needs to know.
boolean	hasChildren()
int	hashCode()
CapabilityStatement.Rest.Builder	toBuilder()	Create a new Builder from the contents of this Element

Methods inherited from class com.ibm.fhir.model.type.BackboneElement

getModifierExtension

Methods inherited from class com.ibm.fhir.model.type.Element

as, getExtension, getId, hasValue, is

Methods inherited from class com.ibm.fhir.model.visitor.AbstractVisitable

accept, accept, accept, accept, accept, accept, accept, accept, accept, accept, accept, accept, accept, toString

Methods inherited from class java.lang.Object

clone, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.ibm.fhir.model.visitor.Visitable

accept, accept

Method Detail

getMode

public RestfulCapabilityMode getMode()

Identifies whether this portion of the statement is describing the ability to initiate or receive restful operations.

Returns:

An immutable object of type RestfulCapabilityMode that is non-null.

getDocumentation

public Markdown getDocumentation()

Information about the system's restful capabilities that apply across all applications, such as security.

Returns:

An immutable object of type Markdown that may be null.

getSecurity

public CapabilityStatement.Rest.Security getSecurity()

Information about security implementation from an interface perspective - what a client needs to know.

Returns:

An immutable object of type CapabilityStatement.Rest.Security that may be null.

getResource

public List<CapabilityStatement.Rest.Resource> getResource()

A specification of the restful capabilities of the solution for a specific resource type.

Returns:

An unmodifiable list containing immutable objects of type CapabilityStatement.Rest.Resource that may be empty.

getInteraction

public List<CapabilityStatement.Rest.Interaction> getInteraction()

A specification of restful operations supported by the system.

Returns:

An unmodifiable list containing immutable objects of type CapabilityStatement.Rest.Interaction that may be empty.

getSearchParam

public List<CapabilityStatement.Rest.Resource.SearchParam> getSearchParam()

Search parameters that are supported for searching all resources for implementations to support and/or make use of - either references to ones defined in the specification, or additional ones defined for/by the implementation.

Returns:

An unmodifiable list containing immutable objects of type SearchParam that may be empty.

getOperation

public List<CapabilityStatement.Rest.Resource.Operation> getOperation()

Definition of an operation or a named query together with its parameters and their meaning and type.

Returns:

An unmodifiable list containing immutable objects of type Operation that may be empty.

getCompartment

public List<Canonical> getCompartment()

An absolute URI which is a reference to the definition of a compartment that the system supports. The reference is to a CompartmentDefinition resource by its canonical URL .

Returns:

An unmodifiable list containing immutable objects of type Canonical that may be empty.

hasChildren

public boolean hasChildren()

Overrides:

hasChildren in class BackboneElement

accept

public void accept(String elementName,
                   int elementIndex,
                   Visitor visitor)

Description copied from interface: Visitable

Accept a Visitor and invoke the appropriate visit methods. A typical implementation would look like this:

 if (visitor.preVisit(this)) {
     visitor.visitStart(elementName, elementIndex, this);
     if (visitor.visit(elementName, elementIndex, this)) {
         // visit children
     }
     visitor.visitEnd(elementName, elementIndex, this);
     visitor.postVisit(this);
 }
 

Specified by:

accept in interface Visitable

Specified by:

accept in class AbstractVisitable

Parameters:

elementName - the name of the element in the context of this visit

elementIndex - the index of the element in a list or -1 if it is not contained within a List

visitor - the visitor to use

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toBuilder

public CapabilityStatement.Rest.Builder toBuilder()

Description copied from class: Element

Create a new Builder from the contents of this Element

Specified by:

toBuilder in class BackboneElement

builder

public static CapabilityStatement.Rest.Builder builder()