Class OperationDefinition.Parameter.Builder
- java.lang.Object
-
- org.linuxforhealth.fhir.model.builder.AbstractBuilder<Element>
-
- org.linuxforhealth.fhir.model.type.Element.Builder
-
- org.linuxforhealth.fhir.model.type.BackboneElement.Builder
-
- org.linuxforhealth.fhir.model.resource.OperationDefinition.Parameter.Builder
-
- Enclosing class:
- OperationDefinition.Parameter
public static class OperationDefinition.Parameter.Builder extends BackboneElement.Builder
-
-
Field Summary
-
Fields inherited from class org.linuxforhealth.fhir.model.type.BackboneElement.Builder
modifierExtension
-
Fields inherited from class org.linuxforhealth.fhir.model.type.Element.Builder
extension, id
-
Fields inherited from class org.linuxforhealth.fhir.model.builder.AbstractBuilder
validating
-
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description OperationDefinition.Parameter.Builder
binding(OperationDefinition.Parameter.Binding binding)
Binds to a value set if this parameter is coded (code, Coding, CodeableConcept).OperationDefinition.Parameter
build()
Build theOperationDefinition.Parameter
OperationDefinition.Parameter.Builder
documentation(java.lang.String documentation)
Convenience method for settingdocumentation
.OperationDefinition.Parameter.Builder
documentation(String documentation)
Describes the meaning or use of this parameter.OperationDefinition.Parameter.Builder
extension(java.util.Collection<Extension> extension)
May be used to represent additional information that is not part of the basic definition of the element.OperationDefinition.Parameter.Builder
extension(Extension... extension)
May be used to represent additional information that is not part of the basic definition of the element.protected OperationDefinition.Parameter.Builder
from(OperationDefinition.Parameter parameter)
OperationDefinition.Parameter.Builder
id(java.lang.String id)
Unique id for the element within a resource (for internal references).OperationDefinition.Parameter.Builder
max(java.lang.String max)
Convenience method for settingmax
.OperationDefinition.Parameter.Builder
max(String max)
The maximum number of times this element is permitted to appear in the request or response.OperationDefinition.Parameter.Builder
min(java.lang.Integer min)
Convenience method for settingmin
.OperationDefinition.Parameter.Builder
min(Integer min)
The minimum number of times this parameter SHALL appear in the request or response.OperationDefinition.Parameter.Builder
modifierExtension(java.util.Collection<Extension> modifierExtension)
May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants.OperationDefinition.Parameter.Builder
modifierExtension(Extension... modifierExtension)
May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants.OperationDefinition.Parameter.Builder
name(Code name)
The name of used to identify the parameter.OperationDefinition.Parameter.Builder
part(java.util.Collection<OperationDefinition.Parameter> part)
The parts of a nested Parameter.OperationDefinition.Parameter.Builder
part(OperationDefinition.Parameter... part)
The parts of a nested Parameter.OperationDefinition.Parameter.Builder
referencedFrom(java.util.Collection<OperationDefinition.Parameter.ReferencedFrom> referencedFrom)
Identifies other resource parameters within the operation invocation that are expected to resolve to this resource.OperationDefinition.Parameter.Builder
referencedFrom(OperationDefinition.Parameter.ReferencedFrom... referencedFrom)
Identifies other resource parameters within the operation invocation that are expected to resolve to this resource.OperationDefinition.Parameter.Builder
searchType(SearchParamType searchType)
How the parameter is understood as a search parameter.OperationDefinition.Parameter.Builder
targetProfile(java.util.Collection<Canonical> 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.OperationDefinition.Parameter.Builder
targetProfile(Canonical... 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.OperationDefinition.Parameter.Builder
type(FHIRAllTypes type)
The type for this parameter.OperationDefinition.Parameter.Builder
use(OperationParameterUse use)
Whether this is an input or an output parameter.protected void
validate(OperationDefinition.Parameter parameter)
-
Methods inherited from class org.linuxforhealth.fhir.model.type.BackboneElement.Builder
from, validate
-
Methods inherited from class org.linuxforhealth.fhir.model.type.Element.Builder
from, validate
-
Methods inherited from class org.linuxforhealth.fhir.model.builder.AbstractBuilder
isValidating, setValidating
-
-
-
-
Method Detail
-
id
public OperationDefinition.Parameter.Builder id(java.lang.String id)
Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.- Overrides:
id
in classBackboneElement.Builder
- Parameters:
id
- Unique id for inter-element referencing- Returns:
- A reference to this Builder instance
-
extension
public OperationDefinition.Parameter.Builder extension(Extension... extension)
May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.Adds new element(s) to the existing list. If any of the elements are null, calling
build()
will fail.- Overrides:
extension
in classBackboneElement.Builder
- Parameters:
extension
- Additional content defined by implementations- Returns:
- A reference to this Builder instance
-
extension
public OperationDefinition.Parameter.Builder extension(java.util.Collection<Extension> extension)
May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.Replaces the existing list with a new one containing elements from the Collection. If any of the elements are null, calling
build()
will fail.- Overrides:
extension
in classBackboneElement.Builder
- Parameters:
extension
- Additional content defined by implementations- Returns:
- A reference to this Builder instance
- Throws:
java.lang.NullPointerException
- If the passed collection is null
-
modifierExtension
public OperationDefinition.Parameter.Builder modifierExtension(Extension... modifierExtension)
May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Adds new element(s) to the existing list. If any of the elements are null, calling
build()
will fail.- Overrides:
modifierExtension
in classBackboneElement.Builder
- Parameters:
modifierExtension
- Extensions that cannot be ignored even if unrecognized- Returns:
- A reference to this Builder instance
-
modifierExtension
public OperationDefinition.Parameter.Builder modifierExtension(java.util.Collection<Extension> modifierExtension)
May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Replaces the existing list with a new one containing elements from the Collection. If any of the elements are null, calling
build()
will fail.- Overrides:
modifierExtension
in classBackboneElement.Builder
- Parameters:
modifierExtension
- Extensions that cannot be ignored even if unrecognized- Returns:
- A reference to this Builder instance
- Throws:
java.lang.NullPointerException
- If the passed collection is null
-
name
public OperationDefinition.Parameter.Builder name(Code name)
The name of used to identify the parameter.This element is required.
- Parameters:
name
- Name in Parameters.parameter.name or in URL- Returns:
- A reference to this Builder instance
-
use
public OperationDefinition.Parameter.Builder use(OperationParameterUse use)
Whether this is an input or an output parameter.This element is required.
- Parameters:
use
- in | out- Returns:
- A reference to this Builder instance
-
min
public OperationDefinition.Parameter.Builder min(java.lang.Integer min)
Convenience method for settingmin
.This element is required.
- Parameters:
min
- Minimum Cardinality- Returns:
- A reference to this Builder instance
- See Also:
min(org.linuxforhealth.fhir.model.type.Integer)
-
min
public OperationDefinition.Parameter.Builder min(Integer min)
The minimum number of times this parameter SHALL appear in the request or response.This element is required.
- Parameters:
min
- Minimum Cardinality- Returns:
- A reference to this Builder instance
-
max
public OperationDefinition.Parameter.Builder max(java.lang.String max)
Convenience method for settingmax
.This element is required.
- Parameters:
max
- Maximum Cardinality (a number or *)- Returns:
- A reference to this Builder instance
- See Also:
max(org.linuxforhealth.fhir.model.type.String)
-
max
public OperationDefinition.Parameter.Builder max(String max)
The maximum number of times this element is permitted to appear in the request or response.This element is required.
- Parameters:
max
- Maximum Cardinality (a number or *)- Returns:
- A reference to this Builder instance
-
documentation
public OperationDefinition.Parameter.Builder documentation(java.lang.String documentation)
Convenience method for settingdocumentation
.- Parameters:
documentation
- Description of meaning/use- Returns:
- A reference to this Builder instance
- See Also:
documentation(org.linuxforhealth.fhir.model.type.String)
-
documentation
public OperationDefinition.Parameter.Builder documentation(String documentation)
Describes the meaning or use of this parameter.- Parameters:
documentation
- Description of meaning/use- Returns:
- A reference to this Builder instance
-
type
public OperationDefinition.Parameter.Builder type(FHIRAllTypes type)
The type for this parameter.- Parameters:
type
- What type this parameter has- Returns:
- A reference to this Builder instance
-
targetProfile
public OperationDefinition.Parameter.Builder targetProfile(Canonical... 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.Adds new element(s) to the existing list. If any of the elements are null, calling
build()
will fail.- Parameters:
targetProfile
- If type is Reference | canonical, allowed targets- Returns:
- A reference to this Builder instance
-
targetProfile
public OperationDefinition.Parameter.Builder targetProfile(java.util.Collection<Canonical> 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.Replaces the existing list with a new one containing elements from the Collection. If any of the elements are null, calling
build()
will fail.- Parameters:
targetProfile
- If type is Reference | canonical, allowed targets- Returns:
- A reference to this Builder instance
- Throws:
java.lang.NullPointerException
- If the passed collection is null
-
searchType
public OperationDefinition.Parameter.Builder searchType(SearchParamType searchType)
How the parameter is understood as a search parameter. This is only used if the parameter type is 'string'.- Parameters:
searchType
- number | date | string | token | reference | composite | quantity | uri | special- Returns:
- A reference to this Builder instance
-
binding
public OperationDefinition.Parameter.Builder binding(OperationDefinition.Parameter.Binding binding)
Binds to a value set if this parameter is coded (code, Coding, CodeableConcept).- Parameters:
binding
- ValueSet details if this is coded- Returns:
- A reference to this Builder instance
-
referencedFrom
public OperationDefinition.Parameter.Builder referencedFrom(OperationDefinition.Parameter.ReferencedFrom... referencedFrom)
Identifies other resource parameters within the operation invocation that are expected to resolve to this resource.Adds new element(s) to the existing list. If any of the elements are null, calling
build()
will fail.- Parameters:
referencedFrom
- References to this parameter- Returns:
- A reference to this Builder instance
-
referencedFrom
public OperationDefinition.Parameter.Builder referencedFrom(java.util.Collection<OperationDefinition.Parameter.ReferencedFrom> referencedFrom)
Identifies other resource parameters within the operation invocation that are expected to resolve to this resource.Replaces the existing list with a new one containing elements from the Collection. If any of the elements are null, calling
build()
will fail.- Parameters:
referencedFrom
- References to this parameter- Returns:
- A reference to this Builder instance
- Throws:
java.lang.NullPointerException
- If the passed collection is null
-
part
public OperationDefinition.Parameter.Builder part(OperationDefinition.Parameter... part)
The parts of a nested Parameter.Adds new element(s) to the existing list. If any of the elements are null, calling
build()
will fail.- Parameters:
part
- Parts of a nested Parameter- Returns:
- A reference to this Builder instance
-
part
public OperationDefinition.Parameter.Builder part(java.util.Collection<OperationDefinition.Parameter> part)
The parts of a nested Parameter.Replaces the existing list with a new one containing elements from the Collection. If any of the elements are null, calling
build()
will fail.- Parameters:
part
- Parts of a nested Parameter- Returns:
- A reference to this Builder instance
- Throws:
java.lang.NullPointerException
- If the passed collection is null
-
build
public OperationDefinition.Parameter build()
- Specified by:
build
in interfaceBuilder<Element>
- Specified by:
build
in classBackboneElement.Builder
- Returns:
- An immutable object of type
OperationDefinition.Parameter
- Throws:
java.lang.IllegalStateException
- if the current state cannot be built into a valid Parameter per the base specification
-
validate
protected void validate(OperationDefinition.Parameter parameter)
-
from
protected OperationDefinition.Parameter.Builder from(OperationDefinition.Parameter parameter)
-
-