public static class OperationDefinition.OperationDefinitionParameterComponent extends BackboneElement implements org.hl7.fhir.instance.model.api.IBaseBackboneElement
| Modifier and Type | Field and 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 List<OperationDefinition.OperationDefinitionParameterReferencedFromComponent> |
referencedFrom
Identifies other resource parameters within the operation invocation that are expected to resolve to this resource.
|
protected Enumeration<Enumerations.SearchParamType> |
searchType
How the parameter is understood as a search parameter.
|
protected List<CanonicalType> |
targetProfile
Used when the type is "Reference" or "canonical", and identifies a profile structure or implementation Guide that applies to the target of the reference this parameter refers to.
|
protected CodeType |
type
The type for this parameter.
|
protected Enumeration<OperationDefinition.OperationParameterUse> |
use
Whether this is an input or an output parameter.
|
modifierExtension| Constructor and Description |
|---|
OperationDefinitionParameterComponent()
Constructor
|
OperationDefinitionParameterComponent(CodeType name,
Enumeration<OperationDefinition.OperationParameterUse> use,
IntegerType min,
StringType max)
Constructor
|
addModifierExtension, addModifierExtension, checkNoModifiers, copyValues, getModifierExtension, getModifierExtensionFirstRep, hasModifierExtension, setModifierExtensionaddExtension, addExtension, addExtension, copyValues, getExtension, getExtensionByUrl, getExtensionFirstRep, getExtensionsByUrl, getExtensionString, getId, getIdBase, getIdElement, hasExtension, hasExtension, hasId, hasIdElement, isDisallowExtensions, noExtensions, removeExtension, setDisallowExtensions, setExtension, setId, setIdBase, setIdElementcastToAddress, castToAnnotation, castToAttachment, castToBase64Binary, castToBoolean, castToCanonical, castToCode, castToCodeableConcept, castToCoding, castToContactDetail, castToContactPoint, castToContributor, castToDataRequirement, castToDate, castToDateTime, castToDecimal, castToDosage, castToDuration, castToElementDefinition, castToExpression, castToExtension, castToHumanName, castToId, castToIdentifier, castToInstant, castToInteger, castToMarkdown, castToMarketingStatus, castToMeta, castToMoney, castToNarrative, castToOid, castToParameterDefinition, castToPeriod, castToPopulation, castToPositiveInt, castToProdCharacteristic, castToProductShelfLife, castToQuantity, castToRange, castToRatio, castToReference, castToRelatedArtifact, castToResource, castToSampledData, castToSignature, castToSimpleQuantity, castToString, castToSubstanceAmount, castToTime, castToTiming, castToTriggerDefinition, castToType, castToUnsignedInt, castToUri, castToUrl, castToUsageContext, castToXhtml, castToXhtmlString, children, clearUserData, compareDeep, compareDeep, compareDeep, compareDeep, compareValues, compareValues, dateTimeValue, equals, getChildByName, getFormatCommentsPost, getFormatCommentsPre, getNamedProperty, getUserData, getUserInt, getUserString, hasFormatComment, hasPrimitiveValue, hasType, hasUserData, isBooleanPrimitive, isDateTime, isMetadataBased, isPrimitive, isResource, listChildrenByName, listChildrenByName, primitiveValue, setUserData, setUserDataINNclone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitaddExtension, getExtension, hasExtensiongetFormatCommentsPost, getFormatCommentsPre, getUserData, hasFormatComment, setUserDataprotected Enumeration<OperationDefinition.OperationParameterUse> use
protected IntegerType min
protected StringType max
protected StringType documentation
protected List<CanonicalType> targetProfile
protected Enumeration<Enumerations.SearchParamType> searchType
protected OperationDefinition.OperationDefinitionParameterBindingComponent binding
protected List<OperationDefinition.OperationDefinitionParameterReferencedFromComponent> referencedFrom
protected List<OperationDefinition.OperationDefinitionParameterComponent> part
public OperationDefinitionParameterComponent()
public OperationDefinitionParameterComponent(CodeType name, Enumeration<OperationDefinition.OperationParameterUse> use, IntegerType min, StringType max)
public CodeType getNameElement()
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 valuepublic boolean hasNameElement()
public boolean hasName()
public OperationDefinition.OperationDefinitionParameterComponent setNameElement(CodeType value)
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 valuepublic OperationDefinition.OperationDefinitionParameterComponent setName(String value)
value - The name of used to identify the parameter.public Enumeration<OperationDefinition.OperationParameterUse> getUseElement()
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 valuepublic boolean hasUseElement()
public boolean hasUse()
public OperationDefinition.OperationDefinitionParameterComponent setUseElement(Enumeration<OperationDefinition.OperationParameterUse> value)
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 valuepublic OperationDefinition.OperationParameterUse getUse()
public OperationDefinition.OperationDefinitionParameterComponent setUse(OperationDefinition.OperationParameterUse value)
value - Whether this is an input or an output parameter.public IntegerType getMinElement()
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 valuepublic boolean hasMinElement()
public boolean hasMin()
public OperationDefinition.OperationDefinitionParameterComponent setMinElement(IntegerType value)
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 valuepublic int getMin()
public OperationDefinition.OperationDefinitionParameterComponent setMin(int value)
value - The minimum number of times this parameter SHALL appear in the request or response.public StringType getMaxElement()
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 valuepublic boolean hasMaxElement()
public boolean hasMax()
public OperationDefinition.OperationDefinitionParameterComponent setMaxElement(StringType value)
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 valuepublic String getMax()
public OperationDefinition.OperationDefinitionParameterComponent setMax(String value)
value - The maximum number of times this element is permitted to appear in the request or response.public StringType getDocumentationElement()
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 valuepublic boolean hasDocumentationElement()
public boolean hasDocumentation()
public OperationDefinition.OperationDefinitionParameterComponent setDocumentationElement(StringType value)
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 valuepublic String getDocumentation()
public OperationDefinition.OperationDefinitionParameterComponent setDocumentation(String value)
value - Describes the meaning or use of this parameter.public CodeType getTypeElement()
type (The type for this parameter.). This is the underlying object with id, value and extensions. The accessor "getType" gives direct access to the valuepublic boolean hasTypeElement()
public boolean hasType()
public OperationDefinition.OperationDefinitionParameterComponent setTypeElement(CodeType value)
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 valuepublic OperationDefinition.OperationDefinitionParameterComponent setType(String value)
value - The type for this parameter.public List<CanonicalType> getTargetProfile()
targetProfile (Used when the type is "Reference" or "canonical", and identifies a profile structure or implementation Guide that applies to the target of the reference this parameter refers to. If any profiles are specified, then the content must conform to at least one of them. The URL can be a local reference - to a contained StructureDefinition, or a reference to another StructureDefinition or Implementation Guide by a canonical URL. When an implementation guide is specified, the target resource SHALL conform to at least one profile defined in the implementation guide.)public OperationDefinition.OperationDefinitionParameterComponent setTargetProfile(List<CanonicalType> theTargetProfile)
this for easy method chainingpublic boolean hasTargetProfile()
public CanonicalType addTargetProfileElement()
targetProfile (Used when the type is "Reference" or "canonical", and identifies a profile structure or implementation Guide that applies to the target of the reference this parameter refers to. If any profiles are specified, then the content must conform to at least one of them. The URL can be a local reference - to a contained StructureDefinition, or a reference to another StructureDefinition or Implementation Guide by a canonical URL. When an implementation guide is specified, the target resource SHALL conform to at least one profile defined in the implementation guide.)public OperationDefinition.OperationDefinitionParameterComponent addTargetProfile(String value)
value - targetProfile (Used when the type is "Reference" or "canonical", and identifies a profile structure or implementation Guide that applies to the target of the reference this parameter refers to. If any profiles are specified, then the content must conform to at least one of them. The URL can be a local reference - to a contained StructureDefinition, or a reference to another StructureDefinition or Implementation Guide by a canonical URL. When an implementation guide is specified, the target resource SHALL conform to at least one profile defined in the implementation guide.)public boolean hasTargetProfile(String value)
value - targetProfile (Used when the type is "Reference" or "canonical", and identifies a profile structure or implementation Guide that applies to the target of the reference this parameter refers to. If any profiles are specified, then the content must conform to at least one of them. The URL can be a local reference - to a contained StructureDefinition, or a reference to another StructureDefinition or Implementation Guide by a canonical URL. When an implementation guide is specified, the target resource SHALL conform to at least one profile defined in the implementation guide.)public Enumeration<Enumerations.SearchParamType> getSearchTypeElement()
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 valuepublic boolean hasSearchTypeElement()
public boolean hasSearchType()
public OperationDefinition.OperationDefinitionParameterComponent setSearchTypeElement(Enumeration<Enumerations.SearchParamType> value)
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 valuepublic Enumerations.SearchParamType getSearchType()
public OperationDefinition.OperationDefinitionParameterComponent setSearchType(Enumerations.SearchParamType value)
value - How the parameter is understood as a search parameter. This is only used if the parameter type is 'string'.public OperationDefinition.OperationDefinitionParameterBindingComponent getBinding()
binding (Binds to a value set if this parameter is coded (code, Coding, CodeableConcept).)public boolean hasBinding()
public OperationDefinition.OperationDefinitionParameterComponent setBinding(OperationDefinition.OperationDefinitionParameterBindingComponent value)
value - binding (Binds to a value set if this parameter is coded (code, Coding, CodeableConcept).)public List<OperationDefinition.OperationDefinitionParameterReferencedFromComponent> getReferencedFrom()
referencedFrom (Identifies other resource parameters within the operation invocation that are expected to resolve to this resource.)public OperationDefinition.OperationDefinitionParameterComponent setReferencedFrom(List<OperationDefinition.OperationDefinitionParameterReferencedFromComponent> theReferencedFrom)
this for easy method chainingpublic boolean hasReferencedFrom()
public OperationDefinition.OperationDefinitionParameterReferencedFromComponent addReferencedFrom()
public OperationDefinition.OperationDefinitionParameterComponent addReferencedFrom(OperationDefinition.OperationDefinitionParameterReferencedFromComponent t)
public OperationDefinition.OperationDefinitionParameterReferencedFromComponent getReferencedFromFirstRep()
referencedFrom, creating it if it does not already existpublic List<OperationDefinition.OperationDefinitionParameterComponent> getPart()
part (The parts of a nested Parameter.)public OperationDefinition.OperationDefinitionParameterComponent setPart(List<OperationDefinition.OperationDefinitionParameterComponent> thePart)
this for easy method chainingpublic boolean hasPart()
public OperationDefinition.OperationDefinitionParameterComponent addPart()
public OperationDefinition.OperationDefinitionParameterComponent addPart(OperationDefinition.OperationDefinitionParameterComponent t)
public OperationDefinition.OperationDefinitionParameterComponent getPartFirstRep()
part, creating it if it does not already existprotected void listChildren(List<Property> children)
listChildren in class BackboneElementpublic Property getNamedProperty(int _hash, String _name, boolean _checkValid) throws org.hl7.fhir.exceptions.FHIRException
getNamedProperty in class BackboneElementorg.hl7.fhir.exceptions.FHIRExceptionpublic Base[] getProperty(int hash, String name, boolean checkValid) throws org.hl7.fhir.exceptions.FHIRException
getProperty in class BackboneElementorg.hl7.fhir.exceptions.FHIRExceptionpublic Base setProperty(int hash, String name, Base value) throws org.hl7.fhir.exceptions.FHIRException
setProperty in class BackboneElementorg.hl7.fhir.exceptions.FHIRExceptionpublic Base setProperty(String name, Base value) throws org.hl7.fhir.exceptions.FHIRException
setProperty in class BackboneElementorg.hl7.fhir.exceptions.FHIRExceptionpublic Base makeProperty(int hash, String name) throws org.hl7.fhir.exceptions.FHIRException
makeProperty in class BackboneElementorg.hl7.fhir.exceptions.FHIRExceptionpublic String[] getTypesForProperty(int hash, String name) throws org.hl7.fhir.exceptions.FHIRException
getTypesForProperty in class BackboneElementorg.hl7.fhir.exceptions.FHIRExceptionpublic Base addChild(String name) throws org.hl7.fhir.exceptions.FHIRException
addChild in class BackboneElementorg.hl7.fhir.exceptions.FHIRExceptionpublic OperationDefinition.OperationDefinitionParameterComponent copy()
copy in class BackboneElementpublic void copyValues(OperationDefinition.OperationDefinitionParameterComponent dst)
public boolean equalsDeep(Base other_)
equalsDeep in class BackboneElementpublic boolean equalsShallow(Base other_)
equalsShallow in class BackboneElementpublic boolean isEmpty()
isEmpty in interface org.hl7.fhir.instance.model.api.IBaseisEmpty in class BackboneElementpublic String fhirType()
fhirType in interface org.hl7.fhir.instance.model.api.IBasefhirType in class BackboneElementCopyright © 2014–2021 Health Level 7. All rights reserved.