Class OperationOutcome.Builder
- java.lang.Object
-
- com.ibm.fhir.model.builder.AbstractBuilder<Resource>
-
- com.ibm.fhir.model.resource.Resource.Builder
-
- com.ibm.fhir.model.resource.DomainResource.Builder
-
- com.ibm.fhir.model.resource.OperationOutcome.Builder
-
- Enclosing class:
- OperationOutcome
public static class OperationOutcome.Builder extends DomainResource.Builder
-
-
Field Summary
-
Fields inherited from class com.ibm.fhir.model.resource.DomainResource.Builder
contained, extension, modifierExtension, text
-
Fields inherited from class com.ibm.fhir.model.resource.Resource.Builder
id, implicitRules, language, meta
-
Fields inherited from class com.ibm.fhir.model.builder.AbstractBuilder
validating
-
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description OperationOutcomebuild()Build theOperationOutcomeOperationOutcome.Buildercontained(Resource... contained)These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.OperationOutcome.Buildercontained(Collection<Resource> contained)These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.OperationOutcome.Builderextension(Extension... extension)May be used to represent additional information that is not part of the basic definition of the resource.OperationOutcome.Builderextension(Collection<Extension> extension)May be used to represent additional information that is not part of the basic definition of the resource.protected OperationOutcome.Builderfrom(OperationOutcome operationOutcome)OperationOutcome.Builderid(String id)The logical id of the resource, as used in the URL for the resource.OperationOutcome.BuilderimplicitRules(Uri implicitRules)A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content.OperationOutcome.Builderissue(OperationOutcome.Issue... issue)An error, warning, or information message that results from a system action.OperationOutcome.Builderissue(Collection<OperationOutcome.Issue> issue)An error, warning, or information message that results from a system action.OperationOutcome.Builderlanguage(Code language)The base language in which the resource is written.OperationOutcome.Buildermeta(Meta meta)The metadata about the resource.OperationOutcome.BuildermodifierExtension(Extension... modifierExtension)May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants.OperationOutcome.BuildermodifierExtension(Collection<Extension> modifierExtension)May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants.OperationOutcome.Buildertext(Narrative text)A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human.protected voidvalidate(OperationOutcome operationOutcome)-
Methods inherited from class com.ibm.fhir.model.resource.DomainResource.Builder
from, validate
-
Methods inherited from class com.ibm.fhir.model.resource.Resource.Builder
from, validate
-
Methods inherited from class com.ibm.fhir.model.builder.AbstractBuilder
isValidating, setValidating
-
-
-
-
Method Detail
-
id
public OperationOutcome.Builder id(String id)
The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.- Overrides:
idin classDomainResource.Builder- Parameters:
id- Logical id of this artifact- Returns:
- A reference to this Builder instance
-
meta
public OperationOutcome.Builder meta(Meta meta)
The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.- Overrides:
metain classDomainResource.Builder- Parameters:
meta- Metadata about the resource- Returns:
- A reference to this Builder instance
-
implicitRules
public OperationOutcome.Builder implicitRules(Uri implicitRules)
A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.- Overrides:
implicitRulesin classDomainResource.Builder- Parameters:
implicitRules- A set of rules under which this content was created- Returns:
- A reference to this Builder instance
-
language
public OperationOutcome.Builder language(Code language)
The base language in which the resource is written.- Overrides:
languagein classDomainResource.Builder- Parameters:
language- Language of the resource content- Returns:
- A reference to this Builder instance
-
text
public OperationOutcome.Builder text(Narrative text)
A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.- Overrides:
textin classDomainResource.Builder- Parameters:
text- Text summary of the resource, for human interpretation- Returns:
- A reference to this Builder instance
-
contained
public OperationOutcome.Builder contained(Resource... contained)
These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.Adds new element(s) to the existing list
- Overrides:
containedin classDomainResource.Builder- Parameters:
contained- Contained, inline Resources- Returns:
- A reference to this Builder instance
-
contained
public OperationOutcome.Builder contained(Collection<Resource> contained)
These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.Replaces the existing list with a new one containing elements from the Collection
- Overrides:
containedin classDomainResource.Builder- Parameters:
contained- Contained, inline Resources- Returns:
- A reference to this Builder instance
-
extension
public OperationOutcome.Builder extension(Extension... extension)
May be used to represent additional information that is not part of the basic definition of the resource. 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
- Overrides:
extensionin classDomainResource.Builder- Parameters:
extension- Additional content defined by implementations- Returns:
- A reference to this Builder instance
-
extension
public OperationOutcome.Builder extension(Collection<Extension> extension)
May be used to represent additional information that is not part of the basic definition of the resource. 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
- Overrides:
extensionin classDomainResource.Builder- Parameters:
extension- Additional content defined by implementations- Returns:
- A reference to this Builder instance
-
modifierExtension
public OperationOutcome.Builder modifierExtension(Extension... modifierExtension)
May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it 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 is allowed to 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
- Overrides:
modifierExtensionin classDomainResource.Builder- Parameters:
modifierExtension- Extensions that cannot be ignored- Returns:
- A reference to this Builder instance
-
modifierExtension
public OperationOutcome.Builder modifierExtension(Collection<Extension> modifierExtension)
May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it 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 is allowed to 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
- Overrides:
modifierExtensionin classDomainResource.Builder- Parameters:
modifierExtension- Extensions that cannot be ignored- Returns:
- A reference to this Builder instance
-
issue
public OperationOutcome.Builder issue(OperationOutcome.Issue... issue)
An error, warning, or information message that results from a system action.Adds new element(s) to the existing list
This element is required.
- Parameters:
issue- A single issue associated with the action- Returns:
- A reference to this Builder instance
-
issue
public OperationOutcome.Builder issue(Collection<OperationOutcome.Issue> issue)
An error, warning, or information message that results from a system action.Replaces the existing list with a new one containing elements from the Collection
This element is required.
- Parameters:
issue- A single issue associated with the action- Returns:
- A reference to this Builder instance
-
build
public OperationOutcome build()
- Specified by:
buildin interfaceBuilder<Resource>- Specified by:
buildin classDomainResource.Builder- Returns:
- An immutable object of type
OperationOutcome - Throws:
IllegalStateException- if the current state cannot be built into a valid OperationOutcome per the base specification
-
validate
protected void validate(OperationOutcome operationOutcome)
-
from
protected OperationOutcome.Builder from(OperationOutcome operationOutcome)
-
-