Package com.ibm.fhir.model.resource
Class OperationDefinition.Parameter
- java.lang.Object
-
- com.ibm.fhir.model.visitor.AbstractVisitable
-
- com.ibm.fhir.model.type.Element
-
- com.ibm.fhir.model.type.BackboneElement
-
- com.ibm.fhir.model.resource.OperationDefinition.Parameter
-
- All Implemented Interfaces:
Visitable
- Enclosing class:
- OperationDefinition
public static class OperationDefinition.Parameter extends BackboneElement
The parameters for the operation/query.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classOperationDefinition.Parameter.BindingBinds to a value set if this parameter is coded (code, Coding, CodeableConcept).static classOperationDefinition.Parameter.Builderstatic classOperationDefinition.Parameter.ReferencedFromIdentifies other resource parameters within the operation invocation that are expected to resolve to this resource.
-
Field Summary
-
Fields inherited from class com.ibm.fhir.model.type.BackboneElement
modifierExtension
-
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description voidaccept(java.lang.String elementName, int elementIndex, Visitor visitor)Accept a Visitor and invoke the appropriate visit methods.static OperationDefinition.Parameter.Builderbuilder()booleanequals(java.lang.Object obj)OperationDefinition.Parameter.BindinggetBinding()Binds to a value set if this parameter is coded (code, Coding, CodeableConcept).StringgetDocumentation()Describes the meaning or use of this parameter.StringgetMax()The maximum number of times this element is permitted to appear in the request or response.IntegergetMin()The minimum number of times this parameter SHALL appear in the request or response.CodegetName()The name of used to identify the parameter.java.util.List<OperationDefinition.Parameter>getPart()The parts of a nested Parameter.java.util.List<OperationDefinition.Parameter.ReferencedFrom>getReferencedFrom()Identifies other resource parameters within the operation invocation that are expected to resolve to this resource.SearchParamTypegetSearchType()How the parameter is understood as a search parameter.java.util.List<Canonical>getTargetProfile()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.FHIRAllTypesgetType()The type for this parameter.OperationParameterUsegetUse()Whether this is an input or an output parameter.booleanhasChildren()inthashCode()OperationDefinition.Parameter.BuildertoBuilder()Create a new Builder from the contents of this Element-
Methods inherited from class com.ibm.fhir.model.type.BackboneElement
getModifierExtension
-
-
-
-
Method Detail
-
getName
public Code getName()
The name of used to identify the parameter.- Returns:
- An immutable object of type
Codethat is non-null.
-
getUse
public OperationParameterUse getUse()
Whether this is an input or an output parameter.- Returns:
- An immutable object of type
OperationParameterUsethat is non-null.
-
getMin
public Integer getMin()
The minimum number of times this parameter SHALL appear in the request or response.- Returns:
- An immutable object of type
Integerthat is non-null.
-
getMax
public String getMax()
The maximum number of times this element is permitted to appear in the request or response.- Returns:
- An immutable object of type
Stringthat is non-null.
-
getDocumentation
public String getDocumentation()
Describes the meaning or use of this parameter.- Returns:
- An immutable object of type
Stringthat may be null.
-
getType
public FHIRAllTypes getType()
The type for this parameter.- Returns:
- An immutable object of type
FHIRAllTypesthat may be null.
-
getTargetProfile
public java.util.List<Canonical> getTargetProfile()
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.- Returns:
- An unmodifiable list containing immutable objects of type
Canonicalthat may be empty.
-
getSearchType
public SearchParamType getSearchType()
How the parameter is understood as a search parameter. This is only used if the parameter type is 'string'.- Returns:
- An immutable object of type
SearchParamTypethat may be null.
-
getBinding
public OperationDefinition.Parameter.Binding getBinding()
Binds to a value set if this parameter is coded (code, Coding, CodeableConcept).- Returns:
- An immutable object of type
OperationDefinition.Parameter.Bindingthat may be null.
-
getReferencedFrom
public java.util.List<OperationDefinition.Parameter.ReferencedFrom> getReferencedFrom()
Identifies other resource parameters within the operation invocation that are expected to resolve to this resource.- Returns:
- An unmodifiable list containing immutable objects of type
OperationDefinition.Parameter.ReferencedFromthat may be empty.
-
getPart
public java.util.List<OperationDefinition.Parameter> getPart()
The parts of a nested Parameter.- Returns:
- An unmodifiable list containing immutable objects of type
OperationDefinition.Parameterthat may be empty.
-
hasChildren
public boolean hasChildren()
- Overrides:
hasChildrenin classBackboneElement
-
accept
public void accept(java.lang.String elementName, int elementIndex, Visitor visitor)Description copied from interface:VisitableAccept 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:
acceptin interfaceVisitable- Specified by:
acceptin 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:
equalsin classjava.lang.Object
-
hashCode
public int hashCode()
- Overrides:
hashCodein classjava.lang.Object
-
toBuilder
public OperationDefinition.Parameter.Builder toBuilder()
Description copied from class:ElementCreate a new Builder from the contents of this Element- Specified by:
toBuilderin classBackboneElement
-
builder
public static OperationDefinition.Parameter.Builder builder()
-
-