Conformance.Rest (HAPI FHIR - Core Library 0.7 API)

java.lang.Object
- ca.uhn.fhir.model.api.BaseElement
- - ca.uhn.fhir.model.api.BaseIdentifiableElement
  - - ca.uhn.fhir.model.dstu.resource.Conformance.Rest

All Implemented Interfaces:

ICompositeElement, IElement, IIdentifiableElement, IResourceBlock, ISupportsUndeclaredExtensions

Enclosing class:

Conformance
```
public static class Conformance.Rest
extends BaseIdentifiableElement
implements IResourceBlock
```
Block class for child element: Conformance.rest (If the endpoint is a RESTful one)
Definition: A definition of the restful capabilities of the solution, if any

Constructor Summary

Constructors
Constructor and Description

Conformance.Rest()

Constructors
Constructor and Description
`Conformance.Rest()`

Method Summary

Methods
Modifier and Type	Method and Description
`UriDt`	`addDocumentMailbox()` Adds and returns a new value for documentMailbox (How documents are accepted in /Mailbox)
`Conformance.Rest`	`addDocumentMailbox(String theUri)` Adds a new value for documentMailbox (How documents are accepted in /Mailbox)
`Conformance.RestOperation`	`addOperation()` Adds and returns a new value for operation (What operations are supported?)
`Conformance.RestQuery`	`addQuery()` Adds and returns a new value for query (Definition of a named query)
`Conformance.RestResource`	`addResource()` Adds and returns a new value for resource (Resource served on the REST interface)
`<T extends IElement> List<T>`	`getAllPopulatedChildElementsOfType(Class<T> theType)` Returns a list containing all child elements matching a given type
`StringDt`	`getDocumentation()` Gets the value(s) for documentation (General description of implementation).
`List<UriDt>`	`getDocumentMailbox()` Gets the value(s) for documentMailbox (How documents are accepted in /Mailbox).
`UriDt`	`getDocumentMailboxFirstRep()` Gets the first repetition for documentMailbox (How documents are accepted in /Mailbox), creating it if it does not already exist.
`BoundCodeDt<RestfulConformanceModeEnum>`	`getMode()` Gets the value(s) for mode (client \| server).
`List<Conformance.RestOperation>`	`getOperation()` Gets the value(s) for operation (What operations are supported?).
`Conformance.RestOperation`	`getOperationFirstRep()` Gets the first repetition for operation (What operations are supported?), creating it if it does not already exist.
`List<Conformance.RestQuery>`	`getQuery()` Gets the value(s) for query (Definition of a named query).
`Conformance.RestQuery`	`getQueryFirstRep()` Gets the first repetition for query (Definition of a named query), creating it if it does not already exist.
`List<Conformance.RestResource>`	`getResource()` Gets the value(s) for resource (Resource served on the REST interface).
`Conformance.RestResource`	`getResourceFirstRep()` Gets the first repetition for resource (Resource served on the REST interface), creating it if it does not already exist.
`Conformance.RestSecurity`	`getSecurity()` Gets the value(s) for security (Information about security of implementation).
`boolean`	`isEmpty()`
`Conformance.Rest`	`setDocumentation(String theString)` Sets the value for documentation (General description of implementation)
`Conformance.Rest`	`setDocumentation(StringDt theValue)` Sets the value(s) for documentation (General description of implementation)
`Conformance.Rest`	`setDocumentMailbox(List<UriDt> theValue)` Sets the value(s) for documentMailbox (How documents are accepted in /Mailbox)
`Conformance.Rest`	`setMode(BoundCodeDt<RestfulConformanceModeEnum> theValue)` Sets the value(s) for mode (client \| server)
`Conformance.Rest`	`setMode(RestfulConformanceModeEnum theValue)` Sets the value(s) for mode (client \| server)
`Conformance.Rest`	`setOperation(List<Conformance.RestOperation> theValue)` Sets the value(s) for operation (What operations are supported?)
`Conformance.Rest`	`setQuery(List<Conformance.RestQuery> theValue)` Sets the value(s) for query (Definition of a named query)
`Conformance.Rest`	`setResource(List<Conformance.RestResource> theValue)` Sets the value(s) for resource (Resource served on the REST interface)
`Conformance.Rest`	`setSecurity(Conformance.RestSecurity theValue)` Sets the value(s) for security (Information about security of implementation)

Methods inherited from class ca.uhn.fhir.model.api.BaseIdentifiableElement
getElementSpecificId, getId, setElementSpecificId, setId, setId

Methods inherited from class ca.uhn.fhir.model.api.BaseElement
addUndeclaredExtension, addUndeclaredExtension, addUndeclaredExtension, getAllUndeclaredExtensions, getUndeclaredExtensions, getUndeclaredExtensionsByUrl, getUndeclaredModifierExtensions, isBaseEmpty

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface ca.uhn.fhir.model.api.IIdentifiableElement
getElementSpecificId, getId, setElementSpecificId, setId, setId

- Constructor Detail
  - Conformance.Rest
```
public Conformance.Rest()
```
- Method Detail
  - isEmpty
```
public boolean isEmpty()
```
    Specified by:
    
    isEmpty in interface IElement
  - getAllPopulatedChildElementsOfType
```
public <T extends IElement> List<T> getAllPopulatedChildElementsOfType(Class<T> theType)
```
    Description copied from interface: ICompositeElement
    
    Returns a list containing all child elements matching a given type
    
    Specified by:
    
    getAllPopulatedChildElementsOfType in interface ICompositeElement
    
    Parameters:
    theType - The type to match. If set to null, all child elements will be returned
  - getMode
```
public BoundCodeDt<RestfulConformanceModeEnum> getMode()
```
    Gets the value(s) for mode (client | server). creating it if it does not exist. Will not return null.
    Definition: Identifies whether this portion of the statement is describing ability to initiate or receive restful operations
  - setMode
```
public Conformance.Rest setMode(BoundCodeDt<RestfulConformanceModeEnum> theValue)
```
    Sets the value(s) for mode (client | server)
    Definition: Identifies whether this portion of the statement is describing ability to initiate or receive restful operations
  - setMode
```
public Conformance.Rest setMode(RestfulConformanceModeEnum theValue)
```
    Sets the value(s) for mode (client | server)
    Definition: Identifies whether this portion of the statement is describing ability to initiate or receive restful operations
  - getDocumentation
```
public StringDt getDocumentation()
```
    Gets the value(s) for documentation (General description of implementation). creating it if it does not exist. Will not return null.
    Definition: Information about the system's restful capabilities that apply across all applications, such as security
  - setDocumentation
```
public Conformance.Rest setDocumentation(StringDt theValue)
```
    Sets the value(s) for documentation (General description of implementation)
    Definition: Information about the system's restful capabilities that apply across all applications, such as security
  - setDocumentation
```
public Conformance.Rest setDocumentation(String theString)
```
    Sets the value for documentation (General description of implementation)
    Definition: Information about the system's restful capabilities that apply across all applications, such as security
  - getSecurity
```
public Conformance.RestSecurity getSecurity()
```
    Gets the value(s) for security (Information about security of implementation). creating it if it does not exist. Will not return null.
    Definition: Information about security of implementation
  - setSecurity
```
public Conformance.Rest setSecurity(Conformance.RestSecurity theValue)
```
    Sets the value(s) for security (Information about security of implementation)
    Definition: Information about security of implementation
  - getResource
```
public List<Conformance.RestResource> getResource()
```
    Gets the value(s) for resource (Resource served on the REST interface). creating it if it does not exist. Will not return null.
    Definition: A specification of the restful capabilities of the solution for a specific resource type
  - setResource
```
public Conformance.Rest setResource(List<Conformance.RestResource> theValue)
```
    Sets the value(s) for resource (Resource served on the REST interface)
    Definition: A specification of the restful capabilities of the solution for a specific resource type
  - addResource
```
public Conformance.RestResource addResource()
```
    Adds and returns a new value for resource (Resource served on the REST interface)
    Definition: A specification of the restful capabilities of the solution for a specific resource type
  - getResourceFirstRep
```
public Conformance.RestResource getResourceFirstRep()
```
    Gets the first repetition for resource (Resource served on the REST interface), creating it if it does not already exist.
    Definition: A specification of the restful capabilities of the solution for a specific resource type
  - getOperation
```
public List<Conformance.RestOperation> getOperation()
```
    Gets the value(s) for operation (What operations are supported?). creating it if it does not exist. Will not return null.
    Definition: A specification of restful operations supported by the system
  - setOperation
```
public Conformance.Rest setOperation(List<Conformance.RestOperation> theValue)
```
    Sets the value(s) for operation (What operations are supported?)
    Definition: A specification of restful operations supported by the system
  - addOperation
```
public Conformance.RestOperation addOperation()
```
    Adds and returns a new value for operation (What operations are supported?)
    Definition: A specification of restful operations supported by the system
  - getOperationFirstRep
```
public Conformance.RestOperation getOperationFirstRep()
```
    Gets the first repetition for operation (What operations are supported?), creating it if it does not already exist.
    Definition: A specification of restful operations supported by the system
  - getQuery
```
public List<Conformance.RestQuery> getQuery()
```
    Gets the value(s) for query (Definition of a named query). creating it if it does not exist. Will not return null.
    Definition: Definition of a named query and its parameters and their meaning
  - setQuery
```
public Conformance.Rest setQuery(List<Conformance.RestQuery> theValue)
```
    Sets the value(s) for query (Definition of a named query)
    Definition: Definition of a named query and its parameters and their meaning
  - addQuery
```
public Conformance.RestQuery addQuery()
```
    Adds and returns a new value for query (Definition of a named query)
    Definition: Definition of a named query and its parameters and their meaning
  - getQueryFirstRep
```
public Conformance.RestQuery getQueryFirstRep()
```
    Gets the first repetition for query (Definition of a named query), creating it if it does not already exist.
    Definition: Definition of a named query and its parameters and their meaning
  - getDocumentMailbox
```
public List<UriDt> getDocumentMailbox()
```
    Gets the value(s) for documentMailbox (How documents are accepted in /Mailbox). creating it if it does not exist. Will not return null.
    Definition: A list of profiles that this server implements for accepting documents in the mailbox. If this list is empty, then documents are not accepted. The base specification has the profile identifier \"http://hl7.org/fhir/documents/mailbox\". Other specifications can declare their own identifier for this purpose
  - setDocumentMailbox
```
public Conformance.Rest setDocumentMailbox(List<UriDt> theValue)
```
    Sets the value(s) for documentMailbox (How documents are accepted in /Mailbox)
    Definition: A list of profiles that this server implements for accepting documents in the mailbox. If this list is empty, then documents are not accepted. The base specification has the profile identifier \"http://hl7.org/fhir/documents/mailbox\". Other specifications can declare their own identifier for this purpose
  - addDocumentMailbox
```
public UriDt addDocumentMailbox()
```
    Adds and returns a new value for documentMailbox (How documents are accepted in /Mailbox)
    Definition: A list of profiles that this server implements for accepting documents in the mailbox. If this list is empty, then documents are not accepted. The base specification has the profile identifier \"http://hl7.org/fhir/documents/mailbox\". Other specifications can declare their own identifier for this purpose
  - getDocumentMailboxFirstRep
```
public UriDt getDocumentMailboxFirstRep()
```
    Gets the first repetition for documentMailbox (How documents are accepted in /Mailbox), creating it if it does not already exist.
    Definition: A list of profiles that this server implements for accepting documents in the mailbox. If this list is empty, then documents are not accepted. The base specification has the profile identifier \"http://hl7.org/fhir/documents/mailbox\". Other specifications can declare their own identifier for this purpose
  - addDocumentMailbox
```
public Conformance.Rest addDocumentMailbox(String theUri)
```
    Adds a new value for documentMailbox (How documents are accepted in /Mailbox)
    Definition: A list of profiles that this server implements for accepting documents in the mailbox. If this list is empty, then documents are not accepted. The base specification has the profile identifier \"http://hl7.org/fhir/documents/mailbox\". Other specifications can declare their own identifier for this purpose
    
    Returns:
    Returns a reference to this object, to allow for simple chaining.

Class Conformance.Rest

Constructor Summary

Method Summary

Methods inherited from class ca.uhn.fhir.model.api.BaseIdentifiableElement

Methods inherited from class ca.uhn.fhir.model.api.BaseElement

Methods inherited from class java.lang.Object

Methods inherited from interface ca.uhn.fhir.model.api.IIdentifiableElement

Constructor Detail

Conformance.Rest

Method Detail

isEmpty

getAllPopulatedChildElementsOfType

getMode

setMode

setMode

getDocumentation

setDocumentation

setDocumentation

getSecurity

setSecurity

getResource

setResource

addResource

getResourceFirstRep

getOperation

setOperation

addOperation

getOperationFirstRep

getQuery

setQuery

addQuery

getQueryFirstRep

getDocumentMailbox

setDocumentMailbox

addDocumentMailbox

getDocumentMailboxFirstRep

addDocumentMailbox