Class CapabilityStatement.Rest.Resource
- java.lang.Object
-
- org.linuxforhealth.fhir.model.visitor.AbstractVisitable
-
- org.linuxforhealth.fhir.model.type.Element
-
- org.linuxforhealth.fhir.model.type.BackboneElement
-
- org.linuxforhealth.fhir.model.resource.CapabilityStatement.Rest.Resource
-
- All Implemented Interfaces:
Visitable
- Enclosing class:
- CapabilityStatement.Rest
public static class CapabilityStatement.Rest.Resource extends BackboneElement
A specification of the restful capabilities of the solution for a specific resource type.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
CapabilityStatement.Rest.Resource.Builder
static class
CapabilityStatement.Rest.Resource.Interaction
Identifies a restful operation supported by the solution.static class
CapabilityStatement.Rest.Resource.Operation
Definition of an operation or a named query together with its parameters and their meaning and type.static class
CapabilityStatement.Rest.Resource.SearchParam
Search parameters 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.
-
Field Summary
-
Fields inherited from class org.linuxforhealth.fhir.model.type.BackboneElement
modifierExtension
-
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description void
accept(java.lang.String elementName, int elementIndex, Visitor visitor)
Accept a Visitor and invoke the appropriate visit methods.static CapabilityStatement.Rest.Resource.Builder
builder()
boolean
equals(java.lang.Object obj)
Boolean
getConditionalCreate()
A flag that indicates that the server supports conditional create.ConditionalDeleteStatus
getConditionalDelete()
A code that indicates how the server supports conditional delete.ConditionalReadStatus
getConditionalRead()
A code that indicates how the server supports conditional read.Boolean
getConditionalUpdate()
A flag that indicates that the server supports conditional update.Markdown
getDocumentation()
Additional information about the resource type used by the system.java.util.List<CapabilityStatement.Rest.Resource.Interaction>
getInteraction()
Identifies a restful operation supported by the solution.java.util.List<CapabilityStatement.Rest.Resource.Operation>
getOperation()
Definition of an operation or a named query together with its parameters and their meaning and type.Canonical
getProfile()
A specification of the profile that describes the solution's overall support for the resource, including any constraints on cardinality, bindings, lengths or other limitations.Boolean
getReadHistory()
A flag for whether the server is able to return past versions as part of the vRead operation.java.util.List<ReferenceHandlingPolicy>
getReferencePolicy()
A set of flags that defines how references are supported.java.util.List<String>
getSearchInclude()
A list of _include values supported by the server.java.util.List<CapabilityStatement.Rest.Resource.SearchParam>
getSearchParam()
Search parameters 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.java.util.List<String>
getSearchRevInclude()
A list of _revinclude (reverse include) values supported by the server.java.util.List<Canonical>
getSupportedProfile()
A list of profiles that represent different use cases supported by the system.ResourceTypeCode
getType()
A type of resource exposed via the restful interface.Boolean
getUpdateCreate()
A flag to indicate that the server allows or needs to allow the client to create new identities on the server (that is, the client PUTs to a location where there is no existing resource).ResourceVersionPolicy
getVersioning()
This field is set to no-version to specify that the system does not support (server) or use (client) versioning for this resource type.boolean
hasChildren()
int
hashCode()
CapabilityStatement.Rest.Resource.Builder
toBuilder()
Create a new Builder from the contents of this Element-
Methods inherited from class org.linuxforhealth.fhir.model.type.BackboneElement
getModifierExtension
-
Methods inherited from class org.linuxforhealth.fhir.model.type.Element
as, getExtension, getId, hasValue, is
-
-
-
-
Method Detail
-
getType
public ResourceTypeCode getType()
A type of resource exposed via the restful interface.- Returns:
- An immutable object of type
ResourceTypeCode
that is non-null.
-
getProfile
public Canonical getProfile()
A specification of the profile that describes the solution's overall support for the resource, including any constraints on cardinality, bindings, lengths or other limitations. See further discussion in [Using Profiles] (profiling.html#profile-uses).- Returns:
- An immutable object of type
Canonical
that may be null.
-
getSupportedProfile
public java.util.List<Canonical> getSupportedProfile()
A list of profiles that represent different use cases supported by the system. For a server, "supported by the system" means the system hosts/produces a set of resources that are conformant to a particular profile, and allows clients that use its services to search using this profile and to find appropriate data. For a client, it means the system will search by this profile and process data according to the guidance implicit in the profile. See further discussion in [Using Profiles](profiling.html#profile-uses).- Returns:
- An unmodifiable list containing immutable objects of type
Canonical
that may be empty.
-
getDocumentation
public Markdown getDocumentation()
Additional information about the resource type used by the system.- Returns:
- An immutable object of type
Markdown
that may be null.
-
getInteraction
public java.util.List<CapabilityStatement.Rest.Resource.Interaction> getInteraction()
Identifies a restful operation supported by the solution.- Returns:
- An unmodifiable list containing immutable objects of type
CapabilityStatement.Rest.Resource.Interaction
that may be empty.
-
getVersioning
public ResourceVersionPolicy getVersioning()
This field is set to no-version to specify that the system does not support (server) or use (client) versioning for this resource type. If this has some other value, the server must at least correctly track and populate the versionId meta-property on resources. If the value is 'versioned-update', then the server supports all the versioning features, including using e-tags for version integrity in the API.- Returns:
- An immutable object of type
ResourceVersionPolicy
that may be null.
-
getReadHistory
public Boolean getReadHistory()
A flag for whether the server is able to return past versions as part of the vRead operation.- Returns:
- An immutable object of type
Boolean
that may be null.
-
getUpdateCreate
public Boolean getUpdateCreate()
A flag to indicate that the server allows or needs to allow the client to create new identities on the server (that is, the client PUTs to a location where there is no existing resource). Allowing this operation means that the server allows the client to create new identities on the server.- Returns:
- An immutable object of type
Boolean
that may be null.
-
getConditionalCreate
public Boolean getConditionalCreate()
A flag that indicates that the server supports conditional create.- Returns:
- An immutable object of type
Boolean
that may be null.
-
getConditionalRead
public ConditionalReadStatus getConditionalRead()
A code that indicates how the server supports conditional read.- Returns:
- An immutable object of type
ConditionalReadStatus
that may be null.
-
getConditionalUpdate
public Boolean getConditionalUpdate()
A flag that indicates that the server supports conditional update.- Returns:
- An immutable object of type
Boolean
that may be null.
-
getConditionalDelete
public ConditionalDeleteStatus getConditionalDelete()
A code that indicates how the server supports conditional delete.- Returns:
- An immutable object of type
ConditionalDeleteStatus
that may be null.
-
getReferencePolicy
public java.util.List<ReferenceHandlingPolicy> getReferencePolicy()
A set of flags that defines how references are supported.- Returns:
- An unmodifiable list containing immutable objects of type
ReferenceHandlingPolicy
that may be empty.
-
getSearchInclude
public java.util.List<String> getSearchInclude()
A list of _include values supported by the server.- Returns:
- An unmodifiable list containing immutable objects of type
String
that may be empty.
-
getSearchRevInclude
public java.util.List<String> getSearchRevInclude()
A list of _revinclude (reverse include) values supported by the server.- Returns:
- An unmodifiable list containing immutable objects of type
String
that may be empty.
-
getSearchParam
public java.util.List<CapabilityStatement.Rest.Resource.SearchParam> getSearchParam()
Search parameters 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
CapabilityStatement.Rest.Resource.SearchParam
that may be empty.
-
getOperation
public java.util.List<CapabilityStatement.Rest.Resource.Operation> getOperation()
Definition of an operation or a named query together with its parameters and their meaning and type. Consult the definition of the operation for details about how to invoke the operation, and the parameters.- Returns:
- An unmodifiable list containing immutable objects of type
CapabilityStatement.Rest.Resource.Operation
that may be empty.
-
hasChildren
public boolean hasChildren()
- Overrides:
hasChildren
in classBackboneElement
-
accept
public void accept(java.lang.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 interfaceVisitable
- Specified by:
accept
in classAbstractVisitable
- Parameters:
elementName
- the name of the element in the context of this visitelementIndex
- the index of the element in a list or -1 if it is not contained within a Listvisitor
- the visitor to use
-
equals
public boolean equals(java.lang.Object obj)
- Overrides:
equals
in classjava.lang.Object
-
hashCode
public int hashCode()
- Overrides:
hashCode
in classjava.lang.Object
-
toBuilder
public CapabilityStatement.Rest.Resource.Builder toBuilder()
Description copied from class:Element
Create a new Builder from the contents of this Element- Specified by:
toBuilder
in classBackboneElement
-
builder
public static CapabilityStatement.Rest.Resource.Builder builder()
-
-