OperationDefinition.Parameter (HAPI FHIR Structures

java.lang.Object
- ca.uhn.fhir.model.api.BaseElement
- - ca.uhn.fhir.model.api.BaseIdentifiableElement
  - - ca.uhn.fhir.model.dstu2.resource.OperationDefinition.Parameter

All Implemented Interfaces:

ca.uhn.fhir.model.api.ICompositeElement, ca.uhn.fhir.model.api.IElement, ca.uhn.fhir.model.api.IIdentifiableElement, ca.uhn.fhir.model.api.IResourceBlock, ca.uhn.fhir.model.api.ISupportsUndeclaredExtensions, Serializable, org.hl7.fhir.instance.model.api.IBase

Enclosing class:

OperationDefinition
```
public static class OperationDefinition.Parameter
extends ca.uhn.fhir.model.api.BaseIdentifiableElement
implements ca.uhn.fhir.model.api.IResourceBlock
```
Block class for child element: OperationDefinition.parameter ()
Definition: The parameters for the operation/query

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

Parameter()

Constructors
Constructor and Description
`Parameter()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`OperationDefinition.Parameter`	`addPart()` Adds and returns a new value for part ()
`OperationDefinition.Parameter`	`addPart(OperationDefinition.Parameter theValue)` Adds a given new value for part ()
`<T extends ca.uhn.fhir.model.api.IElement> List<T>`	`getAllPopulatedChildElementsOfType(Class<T> theType)`
`OperationDefinition.ParameterBinding`	`getBinding()` Gets the value(s) for binding ().
`String`	`getDocumentation()` Gets the value(s) for documentation ().
`ca.uhn.fhir.model.primitive.StringDt`	`getDocumentationElement()` Gets the value(s) for documentation ().
`String`	`getMax()` Gets the value(s) for max ().
`ca.uhn.fhir.model.primitive.StringDt`	`getMaxElement()` Gets the value(s) for max ().
`Integer`	`getMin()` Gets the value(s) for min ().
`ca.uhn.fhir.model.primitive.IntegerDt`	`getMinElement()` Gets the value(s) for min ().
`String`	`getName()` Gets the value(s) for name ().
`ca.uhn.fhir.model.primitive.CodeDt`	`getNameElement()` Gets the value(s) for name ().
`List<OperationDefinition.Parameter>`	`getPart()` Gets the value(s) for part ().
`OperationDefinition.Parameter`	`getPartFirstRep()` Gets the first repetition for part (), creating it if it does not already exist.
`ResourceReferenceDt`	`getProfile()` Gets the value(s) for profile ().
`String`	`getType()` Gets the value(s) for type ().
`ca.uhn.fhir.model.primitive.CodeDt`	`getTypeElement()` Gets the value(s) for type ().
`String`	`getUse()` Gets the value(s) for use ().
`ca.uhn.fhir.model.primitive.BoundCodeDt<OperationParameterUseEnum>`	`getUseElement()` Gets the value(s) for use ().
`boolean`	`isEmpty()`
`OperationDefinition.Parameter`	`setBinding(OperationDefinition.ParameterBinding theValue)` Sets the value(s) for binding ()
`OperationDefinition.Parameter`	`setDocumentation(String theString)` Sets the value for documentation ()
`OperationDefinition.Parameter`	`setDocumentation(ca.uhn.fhir.model.primitive.StringDt theValue)` Sets the value(s) for documentation ()
`OperationDefinition.Parameter`	`setMax(String theString)` Sets the value for max ()
`OperationDefinition.Parameter`	`setMax(ca.uhn.fhir.model.primitive.StringDt theValue)` Sets the value(s) for max ()
`OperationDefinition.Parameter`	`setMin(int theInteger)` Sets the value for min ()
`OperationDefinition.Parameter`	`setMin(ca.uhn.fhir.model.primitive.IntegerDt theValue)` Sets the value(s) for min ()
`OperationDefinition.Parameter`	`setName(ca.uhn.fhir.model.primitive.CodeDt theValue)` Sets the value(s) for name ()
`OperationDefinition.Parameter`	`setName(String theCode)` Sets the value for name ()
`OperationDefinition.Parameter`	`setPart(List<OperationDefinition.Parameter> theValue)` Sets the value(s) for part ()
`OperationDefinition.Parameter`	`setProfile(ResourceReferenceDt theValue)` Sets the value(s) for profile ()
`OperationDefinition.Parameter`	`setType(ca.uhn.fhir.model.primitive.CodeDt theValue)` Sets the value(s) for type ()
`OperationDefinition.Parameter`	`setType(String theCode)` Sets the value for type ()
`OperationDefinition.Parameter`	`setUse(ca.uhn.fhir.model.primitive.BoundCodeDt<OperationParameterUseEnum> theValue)` Sets the value(s) for use ()
`OperationDefinition.Parameter`	`setUse(OperationParameterUseEnum theValue)` Sets the value(s) for use ()

Methods inherited from class ca.uhn.fhir.model.api.BaseIdentifiableElement
getElementSpecificId, getId, setElementSpecificId, setId, setId

Methods inherited from class ca.uhn.fhir.model.api.BaseElement
addUndeclaredExtension, addUndeclaredExtension, addUndeclaredExtension, getAllUndeclaredExtensions, getFormatCommentsPost, getFormatCommentsPre, getUndeclaredExtensions, getUndeclaredExtensionsByUrl, getUndeclaredModifierExtensions, hasFormatComment, isBaseEmpty

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface ca.uhn.fhir.model.api.IIdentifiableElement
getElementSpecificId, getId, setElementSpecificId, setId, setId

Methods inherited from interface org.hl7.fhir.instance.model.api.IBase
getFormatCommentsPost, getFormatCommentsPre, hasFormatComment

- Constructor Detail
  - Parameter
```
public Parameter()
```
- Method Detail
  - isEmpty
```
public boolean isEmpty()
```
    Specified by:
    
    isEmpty in interface org.hl7.fhir.instance.model.api.IBase
  - getAllPopulatedChildElementsOfType
```
public <T extends ca.uhn.fhir.model.api.IElement> List<T> getAllPopulatedChildElementsOfType(Class<T> theType)
```
    Specified by:
    
    getAllPopulatedChildElementsOfType in interface ca.uhn.fhir.model.api.ICompositeElement
  - getNameElement
```
public ca.uhn.fhir.model.primitive.CodeDt getNameElement()
```
    Gets the value(s) for name (). creating it if it does not exist. Will not return null.
    Definition: The name of used to identify the parameter
  - getName
```
public String getName()
```
    Gets the value(s) for name (). creating it if it does not exist. This method may return null.
    Definition: The name of used to identify the parameter
  - setName
```
public OperationDefinition.Parameter setName(ca.uhn.fhir.model.primitive.CodeDt theValue)
```
    Sets the value(s) for name ()
    Definition: The name of used to identify the parameter
  - setName
```
public OperationDefinition.Parameter setName(String theCode)
```
    Sets the value for name ()
    Definition: The name of used to identify the parameter
  - getUseElement
```
public ca.uhn.fhir.model.primitive.BoundCodeDt<OperationParameterUseEnum> getUseElement()
```
    Gets the value(s) for use (). creating it if it does not exist. Will not return null.
    Definition: Whether this is an input or an output parameter
  - getUse
```
public String getUse()
```
    Gets the value(s) for use (). creating it if it does not exist. This method may return null.
    Definition: Whether this is an input or an output parameter
  - setUse
```
public OperationDefinition.Parameter setUse(ca.uhn.fhir.model.primitive.BoundCodeDt<OperationParameterUseEnum> theValue)
```
    Sets the value(s) for use ()
    Definition: Whether this is an input or an output parameter
  - setUse
```
public OperationDefinition.Parameter setUse(OperationParameterUseEnum theValue)
```
    Sets the value(s) for use ()
    Definition: Whether this is an input or an output parameter
  - getMinElement
```
public ca.uhn.fhir.model.primitive.IntegerDt getMinElement()
```
    Gets the value(s) for min (). creating it if it does not exist. Will not return null.
    Definition: The minimum number of times this parameter SHALL appear in the request or response
  - getMin
```
public Integer getMin()
```
    Gets the value(s) for min (). creating it if it does not exist. This method may return null.
    Definition: The minimum number of times this parameter SHALL appear in the request or response
  - setMin
```
public OperationDefinition.Parameter setMin(ca.uhn.fhir.model.primitive.IntegerDt theValue)
```
    Sets the value(s) for min ()
    Definition: The minimum number of times this parameter SHALL appear in the request or response
  - setMin
```
public OperationDefinition.Parameter setMin(int theInteger)
```
    Sets the value for min ()
    Definition: The minimum number of times this parameter SHALL appear in the request or response
  - getMaxElement
```
public ca.uhn.fhir.model.primitive.StringDt getMaxElement()
```
    Gets the value(s) for max (). creating it if it does not exist. Will not return null.
    Definition: The maximum number of times this element is permitted to appear in the request or response
  - getMax
```
public String getMax()
```
    Gets the value(s) for max (). creating it if it does not exist. This method may return null.
    Definition: The maximum number of times this element is permitted to appear in the request or response
  - setMax
```
public OperationDefinition.Parameter setMax(ca.uhn.fhir.model.primitive.StringDt theValue)
```
    Sets the value(s) for max ()
    Definition: The maximum number of times this element is permitted to appear in the request or response
  - setMax
```
public OperationDefinition.Parameter setMax(String theString)
```
    Sets the value for max ()
    Definition: The maximum number of times this element is permitted to appear in the request or response
  - getDocumentationElement
```
public ca.uhn.fhir.model.primitive.StringDt getDocumentationElement()
```
    Gets the value(s) for documentation (). creating it if it does not exist. Will not return null.
    Definition: Describes the meaning or use of this parameter
  - getDocumentation
```
public String getDocumentation()
```
    Gets the value(s) for documentation (). creating it if it does not exist. This method may return null.
    Definition: Describes the meaning or use of this parameter
  - setDocumentation
```
public OperationDefinition.Parameter setDocumentation(ca.uhn.fhir.model.primitive.StringDt theValue)
```
    Sets the value(s) for documentation ()
    Definition: Describes the meaning or use of this parameter
  - setDocumentation
```
public OperationDefinition.Parameter setDocumentation(String theString)
```
    Sets the value for documentation ()
    Definition: Describes the meaning or use of this parameter
  - getTypeElement
```
public ca.uhn.fhir.model.primitive.CodeDt getTypeElement()
```
    Gets the value(s) for type (). creating it if it does not exist. Will not return null.
    Definition: The type for this parameter
  - getType
```
public String getType()
```
    Gets the value(s) for type (). creating it if it does not exist. This method may return null.
    Definition: The type for this parameter
  - setType
```
public OperationDefinition.Parameter setType(ca.uhn.fhir.model.primitive.CodeDt theValue)
```
    Sets the value(s) for type ()
    Definition: The type for this parameter
  - setType
```
public OperationDefinition.Parameter setType(String theCode)
```
    Sets the value for type ()
    Definition: The type for this parameter
  - getProfile
```
public ResourceReferenceDt getProfile()
```
    Gets the value(s) for profile (). creating it if it does not exist. Will not return null.
    Definition: A profile the specifies the rules that this parameter must conform to
  - setProfile
```
public OperationDefinition.Parameter setProfile(ResourceReferenceDt theValue)
```
    Sets the value(s) for profile ()
    Definition: A profile the specifies the rules that this parameter must conform to
  - getBinding
```
public OperationDefinition.ParameterBinding getBinding()
```
    Gets the value(s) for binding (). creating it if it does not exist. Will not return null.
    Definition: Binds to a value set if this parameter is coded (code, Coding, CodeableConcept)
  - setBinding
```
public OperationDefinition.Parameter setBinding(OperationDefinition.ParameterBinding theValue)
```
    Sets the value(s) for binding ()
    Definition: Binds to a value set if this parameter is coded (code, Coding, CodeableConcept)
  - getPart
```
public List<OperationDefinition.Parameter> getPart()
```
    Gets the value(s) for part (). creating it if it does not exist. Will not return null.
    Definition: The parts of a Tuple Parameter
  - setPart
```
public OperationDefinition.Parameter setPart(List<OperationDefinition.Parameter> theValue)
```
    Sets the value(s) for part ()
    Definition: The parts of a Tuple Parameter
  - addPart
```
public OperationDefinition.Parameter addPart()
```
    Adds and returns a new value for part ()
    Definition: The parts of a Tuple Parameter
  - addPart
```
public OperationDefinition.Parameter addPart(OperationDefinition.Parameter theValue)
```
    Adds a given new value for part ()
    Definition: The parts of a Tuple Parameter
    
    Parameters:
    
    theValue - The part to add (must not be null)
  - getPartFirstRep
```
public OperationDefinition.Parameter getPartFirstRep()
```
    Gets the first repetition for part (), creating it if it does not already exist.
    Definition: The parts of a Tuple Parameter

Class OperationDefinition.Parameter

Constructor Summary

Method Summary

Methods inherited from class ca.uhn.fhir.model.api.BaseIdentifiableElement

Methods inherited from class ca.uhn.fhir.model.api.BaseElement

Methods inherited from class java.lang.Object

Methods inherited from interface ca.uhn.fhir.model.api.IIdentifiableElement

Methods inherited from interface org.hl7.fhir.instance.model.api.IBase

Constructor Detail

Parameter

Method Detail

isEmpty

getAllPopulatedChildElementsOfType

getNameElement

getName

setName

setName

getUseElement

getUse

setUse

setUse

getMinElement

getMin

setMin

setMin

getMaxElement

getMax

setMax

setMax

getDocumentationElement

getDocumentation

setDocumentation

setDocumentation

getTypeElement

getType

setType

setType

getProfile

setProfile

getBinding

setBinding

getPart

setPart

addPart

addPart

getPartFirstRep