
Package org.hl7.fhir.dstu3.model
Class OperationDefinition.OperationDefinitionParameterComponent
- java.lang.Object
-
- org.hl7.fhir.dstu3.model.Base
-
- org.hl7.fhir.dstu3.model.Element
-
- org.hl7.fhir.dstu3.model.BackboneElement
-
- org.hl7.fhir.dstu3.model.OperationDefinition.OperationDefinitionParameterComponent
-
- All Implemented Interfaces:
ca.uhn.fhir.model.api.IElement
,Serializable
,org.hl7.fhir.instance.model.api.IBase
,org.hl7.fhir.instance.model.api.IBaseBackboneElement
,org.hl7.fhir.instance.model.api.IBaseElement
,org.hl7.fhir.instance.model.api.IBaseHasExtensions
,org.hl7.fhir.instance.model.api.IBaseHasModifierExtensions
- Enclosing class:
- OperationDefinition
public static class OperationDefinition.OperationDefinitionParameterComponent extends BackboneElement implements org.hl7.fhir.instance.model.api.IBaseBackboneElement
- See Also:
- Serialized Form
-
-
Field Summary
Fields Modifier and Type Field Description protected OperationDefinition.OperationDefinitionParameterBindingComponent
binding
Binds to a value set if this parameter is coded (code, Coding, CodeableConcept).protected StringType
documentation
Describes the meaning or use of this parameter.protected StringType
max
The maximum number of times this element is permitted to appear in the request or response.protected IntegerType
min
The minimum number of times this parameter SHALL appear in the request or response.protected CodeType
name
The name of used to identify the parameter.protected List<OperationDefinition.OperationDefinitionParameterComponent>
part
The parts of a nested Parameter.protected Reference
profile
A profile the specifies the rules that this parameter must conform to.protected StructureDefinition
profileTarget
The actual object that is the target of the reference (A profile the specifies the rules that this parameter must conform to.)protected Enumeration<Enumerations.SearchParamType>
searchType
How the parameter is understood as a search parameter.protected CodeType
type
The type for this parameter.protected Enumeration<OperationDefinition.OperationParameterUse>
use
Whether this is an input or an output parameter.-
Fields inherited from class org.hl7.fhir.dstu3.model.BackboneElement
modifierExtension
-
-
Constructor Summary
Constructors Constructor Description OperationDefinitionParameterComponent()
ConstructorOperationDefinitionParameterComponent(CodeType name, Enumeration<OperationDefinition.OperationParameterUse> use, IntegerType min, StringType max)
Constructor
-
Method Summary
-
Methods inherited from class org.hl7.fhir.dstu3.model.BackboneElement
addModifierExtension, addModifierExtension, copyValues, getModifierExtension, getModifierExtensionFirstRep, hasModifierExtension, setModifierExtension
-
Methods inherited from class org.hl7.fhir.dstu3.model.Element
addExtension, addExtension, addExtension, copyValues, getExtension, getExtensionFirstRep, getExtensionsByUrl, getExtensionString, getId, getIdBase, getIdElement, hasExtension, hasExtension, hasId, hasIdElement, setExtension, setId, setIdBase, setIdElement
-
Methods inherited from class org.hl7.fhir.dstu3.model.Base
castToAddress, castToAnnotation, castToAttachment, castToBase64Binary, castToBoolean, castToCode, castToCodeableConcept, castToCoding, castToContactDetail, castToContactPoint, castToContributor, castToDataRequirement, castToDate, castToDateTime, castToDecimal, castToDosage, castToDuration, castToElementDefinition, castToExtension, castToHumanName, castToId, castToIdentifier, castToInstant, castToInteger, castToMarkdown, castToMeta, castToMoney, castToNarrative, castToOid, castToParameterDefinition, castToPeriod, castToPositiveInt, castToQuantity, castToRange, castToRatio, castToReference, castToRelatedArtifact, castToResource, castToSampledData, castToSignature, castToSimpleQuantity, castToString, castToTime, castToTiming, castToTriggerDefinition, castToType, castToUnsignedInt, castToUri, castToUsageContext, castToXhtml, castToXhtmlString, children, clearUserData, compareDeep, compareDeep, compareDeep, compareValues, compareValues, equals, getChildByName, getFormatCommentsPost, getFormatCommentsPre, getNamedProperty, getUserData, getUserInt, getUserString, hasFormatComment, hasPrimitiveValue, hasType, hasUserData, isBooleanPrimitive, isMetadataBased, isPrimitive, isResource, listChildrenByName, listChildrenByName, primitiveValue, setUserData, setUserDataINN
-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface org.hl7.fhir.instance.model.api.IBase
getFormatCommentsPost, getFormatCommentsPre, getUserData, hasFormatComment, setUserData
-
Methods inherited from interface org.hl7.fhir.instance.model.api.IBaseElement
getUserData, setUserData
-
-
-
-
Field Detail
-
use
protected Enumeration<OperationDefinition.OperationParameterUse> use
Whether this is an input or an output parameter.
-
min
protected IntegerType min
The minimum number of times this parameter SHALL appear in the request or response.
-
max
protected StringType max
The maximum number of times this element is permitted to appear in the request or response.
-
documentation
protected StringType documentation
Describes the meaning or use of this parameter.
-
searchType
protected Enumeration<Enumerations.SearchParamType> searchType
How the parameter is understood as a search parameter. This is only used if the parameter type is 'string'.
-
profile
protected Reference profile
A profile the specifies the rules that this parameter must conform to.
-
profileTarget
protected StructureDefinition profileTarget
The actual object that is the target of the reference (A profile the specifies the rules that this parameter must conform to.)
-
binding
protected OperationDefinition.OperationDefinitionParameterBindingComponent binding
Binds to a value set if this parameter is coded (code, Coding, CodeableConcept).
-
part
protected List<OperationDefinition.OperationDefinitionParameterComponent> part
The parts of a nested Parameter.
-
-
Constructor Detail
-
OperationDefinitionParameterComponent
public OperationDefinitionParameterComponent()
Constructor
-
OperationDefinitionParameterComponent
public OperationDefinitionParameterComponent(CodeType name, Enumeration<OperationDefinition.OperationParameterUse> use, IntegerType min, StringType max)
Constructor
-
-
Method Detail
-
getNameElement
public CodeType getNameElement()
- Returns:
name
(The name of used to identify the parameter.). This is the underlying object with id, value and extensions. The accessor "getName" gives direct access to the value
-
hasNameElement
public boolean hasNameElement()
-
hasName
public boolean hasName()
-
setNameElement
public OperationDefinition.OperationDefinitionParameterComponent setNameElement(CodeType value)
- Parameters:
value
-name
(The name of used to identify the parameter.). This is the underlying object with id, value and extensions. The accessor "getName" gives direct access to the value
-
setName
public OperationDefinition.OperationDefinitionParameterComponent setName(String value)
- Parameters:
value
- The name of used to identify the parameter.
-
getUseElement
public Enumeration<OperationDefinition.OperationParameterUse> getUseElement()
- Returns:
use
(Whether this is an input or an output parameter.). This is the underlying object with id, value and extensions. The accessor "getUse" gives direct access to the value
-
hasUseElement
public boolean hasUseElement()
-
hasUse
public boolean hasUse()
-
setUseElement
public OperationDefinition.OperationDefinitionParameterComponent setUseElement(Enumeration<OperationDefinition.OperationParameterUse> value)
- Parameters:
value
-use
(Whether this is an input or an output parameter.). This is the underlying object with id, value and extensions. The accessor "getUse" gives direct access to the value
-
getUse
public OperationDefinition.OperationParameterUse getUse()
- Returns:
- Whether this is an input or an output parameter.
-
setUse
public OperationDefinition.OperationDefinitionParameterComponent setUse(OperationDefinition.OperationParameterUse value)
- Parameters:
value
- Whether this is an input or an output parameter.
-
getMinElement
public IntegerType getMinElement()
- Returns:
min
(The minimum number of times this parameter SHALL appear in the request or response.). This is the underlying object with id, value and extensions. The accessor "getMin" gives direct access to the value
-
hasMinElement
public boolean hasMinElement()
-
hasMin
public boolean hasMin()
-
setMinElement
public OperationDefinition.OperationDefinitionParameterComponent setMinElement(IntegerType value)
- Parameters:
value
-min
(The minimum number of times this parameter SHALL appear in the request or response.). This is the underlying object with id, value and extensions. The accessor "getMin" gives direct access to the value
-
getMin
public int getMin()
- Returns:
- The minimum number of times this parameter SHALL appear in the request or response.
-
setMin
public OperationDefinition.OperationDefinitionParameterComponent setMin(int value)
- Parameters:
value
- The minimum number of times this parameter SHALL appear in the request or response.
-
getMaxElement
public StringType getMaxElement()
- Returns:
max
(The maximum number of times this element is permitted to appear in the request or response.). This is the underlying object with id, value and extensions. The accessor "getMax" gives direct access to the value
-
hasMaxElement
public boolean hasMaxElement()
-
hasMax
public boolean hasMax()
-
setMaxElement
public OperationDefinition.OperationDefinitionParameterComponent setMaxElement(StringType value)
- Parameters:
value
-max
(The maximum number of times this element is permitted to appear in the request or response.). This is the underlying object with id, value and extensions. The accessor "getMax" gives direct access to the value
-
getMax
public String getMax()
- Returns:
- The maximum number of times this element is permitted to appear in the request or response.
-
setMax
public OperationDefinition.OperationDefinitionParameterComponent setMax(String value)
- Parameters:
value
- The maximum number of times this element is permitted to appear in the request or response.
-
getDocumentationElement
public StringType getDocumentationElement()
- Returns:
documentation
(Describes the meaning or use of this parameter.). This is the underlying object with id, value and extensions. The accessor "getDocumentation" gives direct access to the value
-
hasDocumentationElement
public boolean hasDocumentationElement()
-
hasDocumentation
public boolean hasDocumentation()
-
setDocumentationElement
public OperationDefinition.OperationDefinitionParameterComponent setDocumentationElement(StringType value)
- Parameters:
value
-documentation
(Describes the meaning or use of this parameter.). This is the underlying object with id, value and extensions. The accessor "getDocumentation" gives direct access to the value
-
getDocumentation
public String getDocumentation()
- Returns:
- Describes the meaning or use of this parameter.
-
setDocumentation
public OperationDefinition.OperationDefinitionParameterComponent setDocumentation(String value)
- Parameters:
value
- Describes the meaning or use of this parameter.
-
getTypeElement
public CodeType getTypeElement()
- Returns:
type
(The type for this parameter.). This is the underlying object with id, value and extensions. The accessor "getType" gives direct access to the value
-
hasTypeElement
public boolean hasTypeElement()
-
hasType
public boolean hasType()
-
setTypeElement
public OperationDefinition.OperationDefinitionParameterComponent setTypeElement(CodeType value)
- Parameters:
value
-type
(The type for this parameter.). This is the underlying object with id, value and extensions. The accessor "getType" gives direct access to the value
-
setType
public OperationDefinition.OperationDefinitionParameterComponent setType(String value)
- Parameters:
value
- The type for this parameter.
-
getSearchTypeElement
public Enumeration<Enumerations.SearchParamType> getSearchTypeElement()
- Returns:
searchType
(How the parameter is understood as a search parameter. This is only used if the parameter type is 'string'.). This is the underlying object with id, value and extensions. The accessor "getSearchType" gives direct access to the value
-
hasSearchTypeElement
public boolean hasSearchTypeElement()
-
hasSearchType
public boolean hasSearchType()
-
setSearchTypeElement
public OperationDefinition.OperationDefinitionParameterComponent setSearchTypeElement(Enumeration<Enumerations.SearchParamType> value)
- Parameters:
value
-searchType
(How the parameter is understood as a search parameter. This is only used if the parameter type is 'string'.). This is the underlying object with id, value and extensions. The accessor "getSearchType" gives direct access to the value
-
getSearchType
public Enumerations.SearchParamType getSearchType()
- Returns:
- How the parameter is understood as a search parameter. This is only used if the parameter type is 'string'.
-
setSearchType
public OperationDefinition.OperationDefinitionParameterComponent setSearchType(Enumerations.SearchParamType value)
- Parameters:
value
- How the parameter is understood as a search parameter. This is only used if the parameter type is 'string'.
-
getProfile
public Reference getProfile()
- Returns:
profile
(A profile the specifies the rules that this parameter must conform to.)
-
hasProfile
public boolean hasProfile()
-
setProfile
public OperationDefinition.OperationDefinitionParameterComponent setProfile(Reference value)
- Parameters:
value
-profile
(A profile the specifies the rules that this parameter must conform to.)
-
getProfileTarget
public StructureDefinition getProfileTarget()
- Returns:
profile
The actual object that is the target of the reference. The reference library doesn't populate this, but you can use it to hold the resource if you resolve it. (A profile the specifies the rules that this parameter must conform to.)
-
setProfileTarget
public OperationDefinition.OperationDefinitionParameterComponent setProfileTarget(StructureDefinition value)
- Parameters:
value
-profile
The actual object that is the target of the reference. The reference library doesn't use these, but you can use it to hold the resource if you resolve it. (A profile the specifies the rules that this parameter must conform to.)
-
getBinding
public OperationDefinition.OperationDefinitionParameterBindingComponent getBinding()
- Returns:
binding
(Binds to a value set if this parameter is coded (code, Coding, CodeableConcept).)
-
hasBinding
public boolean hasBinding()
-
setBinding
public OperationDefinition.OperationDefinitionParameterComponent setBinding(OperationDefinition.OperationDefinitionParameterBindingComponent value)
- Parameters:
value
-binding
(Binds to a value set if this parameter is coded (code, Coding, CodeableConcept).)
-
getPart
public List<OperationDefinition.OperationDefinitionParameterComponent> getPart()
- Returns:
part
(The parts of a nested Parameter.)
-
setPart
public OperationDefinition.OperationDefinitionParameterComponent setPart(List<OperationDefinition.OperationDefinitionParameterComponent> thePart)
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasPart
public boolean hasPart()
-
addPart
public OperationDefinition.OperationDefinitionParameterComponent addPart()
-
addPart
public OperationDefinition.OperationDefinitionParameterComponent addPart(OperationDefinition.OperationDefinitionParameterComponent t)
-
getPartFirstRep
public OperationDefinition.OperationDefinitionParameterComponent getPartFirstRep()
- Returns:
- The first repetition of repeating field
part
, creating it if it does not already exist
-
listChildren
protected void listChildren(List<Property> children)
- Overrides:
listChildren
in classBackboneElement
-
getNamedProperty
public Property getNamedProperty(int _hash, String _name, boolean _checkValid) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
getNamedProperty
in classBackboneElement
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
getProperty
public Base[] getProperty(int hash, String name, boolean checkValid) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
getProperty
in classBackboneElement
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
setProperty
public Base setProperty(int hash, String name, Base value) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
setProperty
in classBackboneElement
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
setProperty
public Base setProperty(String name, Base value) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
setProperty
in classBackboneElement
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
makeProperty
public Base makeProperty(int hash, String name) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
makeProperty
in classBackboneElement
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
getTypesForProperty
public String[] getTypesForProperty(int hash, String name) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
getTypesForProperty
in classBackboneElement
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
addChild
public Base addChild(String name) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
addChild
in classBackboneElement
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
copy
public OperationDefinition.OperationDefinitionParameterComponent copy()
- Specified by:
copy
in classBackboneElement
-
equalsDeep
public boolean equalsDeep(Base other_)
- Overrides:
equalsDeep
in classBackboneElement
-
equalsShallow
public boolean equalsShallow(Base other_)
- Overrides:
equalsShallow
in classBackboneElement
-
isEmpty
public boolean isEmpty()
- Specified by:
isEmpty
in interfaceorg.hl7.fhir.instance.model.api.IBase
- Overrides:
isEmpty
in classBackboneElement
-
fhirType
public String fhirType()
- Specified by:
fhirType
in interfaceorg.hl7.fhir.instance.model.api.IBase
- Overrides:
fhirType
in classBackboneElement
-
-