public static class Conformance.RestResource extends BaseIdentifiableElement implements IResourceBlock
Definition: A specification of the restful capabilities of the solution for a specific resource type
| Constructor and Description |
|---|
RestResource() |
| Modifier and Type | Method and Description |
|---|---|
Conformance.RestResourceInteraction |
addInteraction()
Adds and returns a new value for interaction ()
|
Conformance.RestResource |
addInteraction(Conformance.RestResourceInteraction theValue)
Adds a given new value for interaction ()
|
StringDt |
addSearchInclude()
Adds and returns a new value for searchInclude ()
|
Conformance.RestResource |
addSearchInclude(String theString)
Adds a new value for searchInclude ()
|
Conformance.RestResource |
addSearchInclude(StringDt theValue)
Adds a given new value for searchInclude ()
|
Conformance.RestResourceSearchParam |
addSearchParam()
Adds and returns a new value for searchParam ()
|
Conformance.RestResource |
addSearchParam(Conformance.RestResourceSearchParam theValue)
Adds a given new value for searchParam ()
|
StringDt |
addSearchRevInclude()
Adds and returns a new value for searchRevInclude ()
|
Conformance.RestResource |
addSearchRevInclude(String theString)
Adds a new value for searchRevInclude ()
|
Conformance.RestResource |
addSearchRevInclude(StringDt theValue)
Adds a given new value for searchRevInclude ()
|
<T extends IElement> |
getAllPopulatedChildElementsOfType(Class<T> theType) |
Boolean |
getConditionalCreate()
Gets the value(s) for conditionalCreate ().
|
BooleanDt |
getConditionalCreateElement()
Gets the value(s) for conditionalCreate ().
|
String |
getConditionalDelete()
Gets the value(s) for conditionalDelete ().
|
BoundCodeDt<ConditionalDeleteStatusEnum> |
getConditionalDeleteElement()
Gets the value(s) for conditionalDelete ().
|
Boolean |
getConditionalUpdate()
Gets the value(s) for conditionalUpdate ().
|
BooleanDt |
getConditionalUpdateElement()
Gets the value(s) for conditionalUpdate ().
|
List<Conformance.RestResourceInteraction> |
getInteraction()
Gets the value(s) for interaction ().
|
Conformance.RestResourceInteraction |
getInteractionFirstRep()
Gets the first repetition for interaction (),
creating it if it does not already exist.
|
ResourceReferenceDt |
getProfile()
Gets the value(s) for profile ().
|
Boolean |
getReadHistory()
Gets the value(s) for readHistory ().
|
BooleanDt |
getReadHistoryElement()
Gets the value(s) for readHistory ().
|
List<StringDt> |
getSearchInclude()
Gets the value(s) for searchInclude ().
|
StringDt |
getSearchIncludeFirstRep()
Gets the first repetition for searchInclude (),
creating it if it does not already exist.
|
List<Conformance.RestResourceSearchParam> |
getSearchParam()
Gets the value(s) for searchParam ().
|
Conformance.RestResourceSearchParam |
getSearchParamFirstRep()
Gets the first repetition for searchParam (),
creating it if it does not already exist.
|
List<StringDt> |
getSearchRevInclude()
Gets the value(s) for searchRevInclude ().
|
StringDt |
getSearchRevIncludeFirstRep()
Gets the first repetition for searchRevInclude (),
creating it if it does not already exist.
|
String |
getType()
Gets the value(s) for type ().
|
BoundCodeDt<ResourceTypeEnum> |
getTypeElement()
Gets the value(s) for type ().
|
Boolean |
getUpdateCreate()
Gets the value(s) for updateCreate ().
|
BooleanDt |
getUpdateCreateElement()
Gets the value(s) for updateCreate ().
|
String |
getVersioning()
Gets the value(s) for versioning ().
|
BoundCodeDt<ResourceVersionPolicyEnum> |
getVersioningElement()
Gets the value(s) for versioning ().
|
boolean |
isEmpty() |
Conformance.RestResource |
setConditionalCreate(boolean theBoolean)
Sets the value for conditionalCreate ()
|
Conformance.RestResource |
setConditionalCreate(BooleanDt theValue)
Sets the value(s) for conditionalCreate ()
|
Conformance.RestResource |
setConditionalDelete(BoundCodeDt<ConditionalDeleteStatusEnum> theValue)
Sets the value(s) for conditionalDelete ()
|
Conformance.RestResource |
setConditionalDelete(ConditionalDeleteStatusEnum theValue)
Sets the value(s) for conditionalDelete ()
|
Conformance.RestResource |
setConditionalUpdate(boolean theBoolean)
Sets the value for conditionalUpdate ()
|
Conformance.RestResource |
setConditionalUpdate(BooleanDt theValue)
Sets the value(s) for conditionalUpdate ()
|
Conformance.RestResource |
setInteraction(List<Conformance.RestResourceInteraction> theValue)
Sets the value(s) for interaction ()
|
Conformance.RestResource |
setProfile(ResourceReferenceDt theValue)
Sets the value(s) for profile ()
|
Conformance.RestResource |
setReadHistory(boolean theBoolean)
Sets the value for readHistory ()
|
Conformance.RestResource |
setReadHistory(BooleanDt theValue)
Sets the value(s) for readHistory ()
|
Conformance.RestResource |
setSearchInclude(List<StringDt> theValue)
Sets the value(s) for searchInclude ()
|
Conformance.RestResource |
setSearchParam(List<Conformance.RestResourceSearchParam> theValue)
Sets the value(s) for searchParam ()
|
Conformance.RestResource |
setSearchRevInclude(List<StringDt> theValue)
Sets the value(s) for searchRevInclude ()
|
Conformance.RestResource |
setType(BoundCodeDt<ResourceTypeEnum> theValue)
Sets the value(s) for type ()
|
Conformance.RestResource |
setType(ResourceTypeEnum theValue)
Sets the value(s) for type ()
|
Conformance.RestResource |
setUpdateCreate(boolean theBoolean)
Sets the value for updateCreate ()
|
Conformance.RestResource |
setUpdateCreate(BooleanDt theValue)
Sets the value(s) for updateCreate ()
|
Conformance.RestResource |
setVersioning(BoundCodeDt<ResourceVersionPolicyEnum> theValue)
Sets the value(s) for versioning ()
|
Conformance.RestResource |
setVersioning(ResourceVersionPolicyEnum theValue)
Sets the value(s) for versioning ()
|
getElementSpecificId, getId, setElementSpecificId, setId, setIdaddUndeclaredExtension, addUndeclaredExtension, addUndeclaredExtension, getAllUndeclaredExtensions, getUndeclaredExtensions, getUndeclaredExtensionsByUrl, getUndeclaredModifierExtensions, isBaseEmptyclone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitgetElementSpecificId, getId, setElementSpecificId, setId, setIdpublic RestResource()
public <T extends IElement> List<T> getAllPopulatedChildElementsOfType(Class<T> theType)
getAllPopulatedChildElementsOfType in interface ICompositeElementpublic BoundCodeDt<ResourceTypeEnum> getTypeElement()
null.
Definition: A type of resource exposed via the restful interface
public String getType()
null.
Definition: A type of resource exposed via the restful interface
public Conformance.RestResource setType(BoundCodeDt<ResourceTypeEnum> theValue)
Definition: A type of resource exposed via the restful interface
public Conformance.RestResource setType(ResourceTypeEnum theValue)
Definition: A type of resource exposed via the restful interface
public ResourceReferenceDt getProfile()
null.
Definition: 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}
public Conformance.RestResource setProfile(ResourceReferenceDt theValue)
Definition: 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}
public List<Conformance.RestResourceInteraction> getInteraction()
null.
Definition: Identifies a restful operation supported by the solution
public Conformance.RestResource setInteraction(List<Conformance.RestResourceInteraction> theValue)
Definition: Identifies a restful operation supported by the solution
public Conformance.RestResourceInteraction addInteraction()
Definition: Identifies a restful operation supported by the solution
public Conformance.RestResource addInteraction(Conformance.RestResourceInteraction theValue)
Definition: Identifies a restful operation supported by the solution
theValue - The interaction to add (must not be null)public Conformance.RestResourceInteraction getInteractionFirstRep()
Definition: Identifies a restful operation supported by the solution
public BoundCodeDt<ResourceVersionPolicyEnum> getVersioningElement()
null.
Definition: 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
public String getVersioning()
null.
Definition: 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
public Conformance.RestResource setVersioning(BoundCodeDt<ResourceVersionPolicyEnum> theValue)
Definition: 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
public Conformance.RestResource setVersioning(ResourceVersionPolicyEnum theValue)
Definition: 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
public BooleanDt getReadHistoryElement()
null.
Definition: A flag for whether the server is able to return past versions as part of the vRead operation
public Boolean getReadHistory()
null.
Definition: A flag for whether the server is able to return past versions as part of the vRead operation
public Conformance.RestResource setReadHistory(BooleanDt theValue)
Definition: A flag for whether the server is able to return past versions as part of the vRead operation
public Conformance.RestResource setReadHistory(boolean theBoolean)
Definition: A flag for whether the server is able to return past versions as part of the vRead operation
public BooleanDt getUpdateCreateElement()
null.
Definition: A flag to indicate that the server allows or needs to allow the client to create new identities on the server (e.g. 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
public Boolean getUpdateCreate()
null.
Definition: A flag to indicate that the server allows or needs to allow the client to create new identities on the server (e.g. 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
public Conformance.RestResource setUpdateCreate(BooleanDt theValue)
Definition: A flag to indicate that the server allows or needs to allow the client to create new identities on the server (e.g. 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
public Conformance.RestResource setUpdateCreate(boolean theBoolean)
Definition: A flag to indicate that the server allows or needs to allow the client to create new identities on the server (e.g. 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
public BooleanDt getConditionalCreateElement()
null.
Definition: A flag that indicates that the server supports conditional create
public Boolean getConditionalCreate()
null.
Definition: A flag that indicates that the server supports conditional create
public Conformance.RestResource setConditionalCreate(BooleanDt theValue)
Definition: A flag that indicates that the server supports conditional create
public Conformance.RestResource setConditionalCreate(boolean theBoolean)
Definition: A flag that indicates that the server supports conditional create
public BooleanDt getConditionalUpdateElement()
null.
Definition: A flag that indicates that the server supports conditional update
public Boolean getConditionalUpdate()
null.
Definition: A flag that indicates that the server supports conditional update
public Conformance.RestResource setConditionalUpdate(BooleanDt theValue)
Definition: A flag that indicates that the server supports conditional update
public Conformance.RestResource setConditionalUpdate(boolean theBoolean)
Definition: A flag that indicates that the server supports conditional update
public BoundCodeDt<ConditionalDeleteStatusEnum> getConditionalDeleteElement()
null.
Definition: A code that indicates how the server supports conditional delete
public String getConditionalDelete()
null.
Definition: A code that indicates how the server supports conditional delete
public Conformance.RestResource setConditionalDelete(BoundCodeDt<ConditionalDeleteStatusEnum> theValue)
Definition: A code that indicates how the server supports conditional delete
public Conformance.RestResource setConditionalDelete(ConditionalDeleteStatusEnum theValue)
Definition: A code that indicates how the server supports conditional delete
public List<StringDt> getSearchInclude()
null.
Definition: A list of _include values supported by the server
public Conformance.RestResource setSearchInclude(List<StringDt> theValue)
Definition: A list of _include values supported by the server
public StringDt addSearchInclude()
Definition: A list of _include values supported by the server
public Conformance.RestResource addSearchInclude(StringDt theValue)
Definition: A list of _include values supported by the server
theValue - The searchInclude to add (must not be null)public StringDt getSearchIncludeFirstRep()
Definition: A list of _include values supported by the server
public Conformance.RestResource addSearchInclude(String theString)
Definition: A list of _include values supported by the server
public List<StringDt> getSearchRevInclude()
null.
Definition: A list of _revinclude (reverse include) values supported by the server
public Conformance.RestResource setSearchRevInclude(List<StringDt> theValue)
Definition: A list of _revinclude (reverse include) values supported by the server
public StringDt addSearchRevInclude()
Definition: A list of _revinclude (reverse include) values supported by the server
public Conformance.RestResource addSearchRevInclude(StringDt theValue)
Definition: A list of _revinclude (reverse include) values supported by the server
theValue - The searchRevInclude to add (must not be null)public StringDt getSearchRevIncludeFirstRep()
Definition: A list of _revinclude (reverse include) values supported by the server
public Conformance.RestResource addSearchRevInclude(String theString)
Definition: A list of _revinclude (reverse include) values supported by the server
public List<Conformance.RestResourceSearchParam> getSearchParam()
null.
Definition: 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
public Conformance.RestResource setSearchParam(List<Conformance.RestResourceSearchParam> theValue)
Definition: 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
public Conformance.RestResourceSearchParam addSearchParam()
Definition: 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
public Conformance.RestResource addSearchParam(Conformance.RestResourceSearchParam theValue)
Definition: 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
theValue - The searchParam to add (must not be null)public Conformance.RestResourceSearchParam getSearchParamFirstRep()
Definition: 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
Copyright © 2014–2016 University Health Network. All rights reserved.