Class CapabilityStatement.Rest.Resource.Operation.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.CapabilityStatement.Rest.Resource.Operation.Builder
-
- Enclosing class:
- CapabilityStatement.Rest.Resource.Operation
public static class CapabilityStatement.Rest.Resource.Operation.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 CapabilityStatement.Rest.Resource.Operation
build()
CapabilityStatement.Rest.Resource.Operation.Builder
definition(Canonical definition)
Where the formal definition can be found.CapabilityStatement.Rest.Resource.Operation.Builder
documentation(Markdown documentation)
Documentation that describes anything special about the operation behavior, possibly detailing different behavior for system, type and instance-level invocation of the operation.CapabilityStatement.Rest.Resource.Operation.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.CapabilityStatement.Rest.Resource.Operation.Builder
extension(Extension... extension)
May be used to represent additional information that is not part of the basic definition of the element.protected CapabilityStatement.Rest.Resource.Operation.Builder
from(CapabilityStatement.Rest.Resource.Operation operation)
CapabilityStatement.Rest.Resource.Operation.Builder
id(java.lang.String id)
Unique id for the element within a resource (for internal references).CapabilityStatement.Rest.Resource.Operation.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.CapabilityStatement.Rest.Resource.Operation.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.CapabilityStatement.Rest.Resource.Operation.Builder
name(java.lang.String name)
Convenience method for settingname
.CapabilityStatement.Rest.Resource.Operation.Builder
name(String name)
The name of the operation or query.protected void
validate(CapabilityStatement.Rest.Resource.Operation operation)
-
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 CapabilityStatement.Rest.Resource.Operation.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 CapabilityStatement.Rest.Resource.Operation.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 CapabilityStatement.Rest.Resource.Operation.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 CapabilityStatement.Rest.Resource.Operation.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 CapabilityStatement.Rest.Resource.Operation.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 CapabilityStatement.Rest.Resource.Operation.Builder name(java.lang.String name)
Convenience method for settingname
.This element is required.
- Parameters:
name
- Name by which the operation/query is invoked- Returns:
- A reference to this Builder instance
- See Also:
name(org.linuxforhealth.fhir.model.type.String)
-
name
public CapabilityStatement.Rest.Resource.Operation.Builder name(String name)
The name of the operation or query. For an operation, this is the name prefixed with $ and used in the URL. For a query, this is the name used in the _query parameter when the query is called.This element is required.
- Parameters:
name
- Name by which the operation/query is invoked- Returns:
- A reference to this Builder instance
-
definition
public CapabilityStatement.Rest.Resource.Operation.Builder definition(Canonical definition)
Where the formal definition can be found. If a server references the base definition of an Operation (i.e. from the specification itself such as ```http://hl7.org/fhir/OperationDefinition/ValueSet-expand```), that means it supports the full capabilities of the operation - e.g. both GET and POST invocation. If it only supports a subset, it must define its own custom [OperationDefinition](operationdefinition.html#) with a 'base' of the original OperationDefinition. The custom definition would describe the specific subset of functionality supported.This element is required.
- Parameters:
definition
- The defined operation/query- Returns:
- A reference to this Builder instance
-
documentation
public CapabilityStatement.Rest.Resource.Operation.Builder documentation(Markdown documentation)
Documentation that describes anything special about the operation behavior, possibly detailing different behavior for system, type and instance-level invocation of the operation.- Parameters:
documentation
- Specific details about operation behavior- Returns:
- A reference to this Builder instance
-
build
public CapabilityStatement.Rest.Resource.Operation build()
- Specified by:
build
in interfaceBuilder<Element>
- Specified by:
build
in classBackboneElement.Builder
- Returns:
- An immutable object of type
CapabilityStatement.Rest.Resource.Operation
- Throws:
java.lang.IllegalStateException
- if the current state cannot be built into a valid Operation per the base specification
-
validate
protected void validate(CapabilityStatement.Rest.Resource.Operation operation)
-
from
protected CapabilityStatement.Rest.Resource.Operation.Builder from(CapabilityStatement.Rest.Resource.Operation operation)
-
-