Class CapabilityStatement.Rest.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.Builder
-
- Enclosing class:
- CapabilityStatement.Rest
public static class CapabilityStatement.Rest.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
build()
Build theCapabilityStatement.Rest
CapabilityStatement.Rest.Builder
compartment(java.util.Collection<Canonical> compartment)
An absolute URI which is a reference to the definition of a compartment that the system supports.CapabilityStatement.Rest.Builder
compartment(Canonical... compartment)
An absolute URI which is a reference to the definition of a compartment that the system supports.CapabilityStatement.Rest.Builder
documentation(Markdown documentation)
Information about the system's restful capabilities that apply across all applications, such as security.CapabilityStatement.Rest.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.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.Builder
from(CapabilityStatement.Rest rest)
CapabilityStatement.Rest.Builder
id(java.lang.String id)
Unique id for the element within a resource (for internal references).CapabilityStatement.Rest.Builder
interaction(java.util.Collection<CapabilityStatement.Rest.Interaction> interaction)
A specification of restful operations supported by the system.CapabilityStatement.Rest.Builder
interaction(CapabilityStatement.Rest.Interaction... interaction)
A specification of restful operations supported by the system.CapabilityStatement.Rest.Builder
mode(RestfulCapabilityMode mode)
Identifies whether this portion of the statement is describing the ability to initiate or receive restful operations.CapabilityStatement.Rest.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.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.Builder
operation(java.util.Collection<CapabilityStatement.Rest.Resource.Operation> operation)
Definition of an operation or a named query together with its parameters and their meaning and type.CapabilityStatement.Rest.Builder
operation(CapabilityStatement.Rest.Resource.Operation... operation)
Definition of an operation or a named query together with its parameters and their meaning and type.CapabilityStatement.Rest.Builder
resource(java.util.Collection<CapabilityStatement.Rest.Resource> resource)
A specification of the restful capabilities of the solution for a specific resource type.CapabilityStatement.Rest.Builder
resource(CapabilityStatement.Rest.Resource... resource)
A specification of the restful capabilities of the solution for a specific resource type.CapabilityStatement.Rest.Builder
searchParam(java.util.Collection<CapabilityStatement.Rest.Resource.SearchParam> searchParam)
Search parameters that are supported for searching all resources for implementations to support and/or make use of - either references to ones defined in the specification, or additional ones defined for/by the implementation.CapabilityStatement.Rest.Builder
searchParam(CapabilityStatement.Rest.Resource.SearchParam... searchParam)
Search parameters that are supported for searching all resources for implementations to support and/or make use of - either references to ones defined in the specification, or additional ones defined for/by the implementation.CapabilityStatement.Rest.Builder
security(CapabilityStatement.Rest.Security security)
Information about security implementation from an interface perspective - what a client needs to know.protected void
validate(CapabilityStatement.Rest rest)
-
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.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.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.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.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.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
-
mode
public CapabilityStatement.Rest.Builder mode(RestfulCapabilityMode mode)
Identifies whether this portion of the statement is describing the ability to initiate or receive restful operations.This element is required.
- Parameters:
mode
- client | server- Returns:
- A reference to this Builder instance
-
documentation
public CapabilityStatement.Rest.Builder documentation(Markdown documentation)
Information about the system's restful capabilities that apply across all applications, such as security.- Parameters:
documentation
- General description of implementation- Returns:
- A reference to this Builder instance
-
security
public CapabilityStatement.Rest.Builder security(CapabilityStatement.Rest.Security security)
Information about security implementation from an interface perspective - what a client needs to know.- Parameters:
security
- Information about security of implementation- Returns:
- A reference to this Builder instance
-
resource
public CapabilityStatement.Rest.Builder resource(CapabilityStatement.Rest.Resource... resource)
A specification of the restful capabilities of the solution for a specific resource type.Adds new element(s) to the existing list. If any of the elements are null, calling
build()
will fail.- Parameters:
resource
- Resource served on the REST interface- Returns:
- A reference to this Builder instance
-
resource
public CapabilityStatement.Rest.Builder resource(java.util.Collection<CapabilityStatement.Rest.Resource> resource)
A specification of the restful capabilities of the solution for a specific resource type.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:
resource
- Resource served on the REST interface- Returns:
- A reference to this Builder instance
- Throws:
java.lang.NullPointerException
- If the passed collection is null
-
interaction
public CapabilityStatement.Rest.Builder interaction(CapabilityStatement.Rest.Interaction... interaction)
A specification of restful operations supported by the system.Adds new element(s) to the existing list. If any of the elements are null, calling
build()
will fail.- Parameters:
interaction
- What operations are supported?- Returns:
- A reference to this Builder instance
-
interaction
public CapabilityStatement.Rest.Builder interaction(java.util.Collection<CapabilityStatement.Rest.Interaction> interaction)
A specification of restful operations supported by the system.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:
interaction
- What operations are supported?- Returns:
- A reference to this Builder instance
- Throws:
java.lang.NullPointerException
- If the passed collection is null
-
searchParam
public CapabilityStatement.Rest.Builder searchParam(CapabilityStatement.Rest.Resource.SearchParam... searchParam)
Search parameters that are supported for searching all resources for implementations to support and/or make use of - either references to ones defined in the specification, or additional ones defined for/by the implementation.Adds new element(s) to the existing list. If any of the elements are null, calling
build()
will fail.- Parameters:
searchParam
- Search parameters for searching all resources- Returns:
- A reference to this Builder instance
-
searchParam
public CapabilityStatement.Rest.Builder searchParam(java.util.Collection<CapabilityStatement.Rest.Resource.SearchParam> searchParam)
Search parameters that are supported for searching all resources for implementations to support and/or make use of - either references to ones defined in the specification, or additional ones defined for/by the implementation.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:
searchParam
- Search parameters for searching all resources- Returns:
- A reference to this Builder instance
- Throws:
java.lang.NullPointerException
- If the passed collection is null
-
operation
public CapabilityStatement.Rest.Builder operation(CapabilityStatement.Rest.Resource.Operation... operation)
Definition of an operation or a named query together with its parameters and their meaning and type.Adds new element(s) to the existing list. If any of the elements are null, calling
build()
will fail.- Parameters:
operation
- Definition of a system level operation- Returns:
- A reference to this Builder instance
-
operation
public CapabilityStatement.Rest.Builder operation(java.util.Collection<CapabilityStatement.Rest.Resource.Operation> operation)
Definition of an operation or a named query together with its parameters and their meaning and type.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:
operation
- Definition of a system level operation- Returns:
- A reference to this Builder instance
- Throws:
java.lang.NullPointerException
- If the passed collection is null
-
compartment
public CapabilityStatement.Rest.Builder compartment(Canonical... compartment)
An absolute URI which is a reference to the definition of a compartment that the system supports. The reference is to a CompartmentDefinition resource by its canonical URL .Adds new element(s) to the existing list. If any of the elements are null, calling
build()
will fail.- Parameters:
compartment
- Compartments served/used by system- Returns:
- A reference to this Builder instance
-
compartment
public CapabilityStatement.Rest.Builder compartment(java.util.Collection<Canonical> compartment)
An absolute URI which is a reference to the definition of a compartment that the system supports. The reference is to a CompartmentDefinition resource by its canonical URL .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:
compartment
- Compartments served/used by system- Returns:
- A reference to this Builder instance
- Throws:
java.lang.NullPointerException
- If the passed collection is null
-
build
public CapabilityStatement.Rest build()
- Specified by:
build
in interfaceBuilder<Element>
- Specified by:
build
in classBackboneElement.Builder
- Returns:
- An immutable object of type
CapabilityStatement.Rest
- Throws:
java.lang.IllegalStateException
- if the current state cannot be built into a valid Rest per the base specification
-
validate
protected void validate(CapabilityStatement.Rest rest)
-
from
protected CapabilityStatement.Rest.Builder from(CapabilityStatement.Rest rest)
-
-