Class OperationOutcome.Issue.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.OperationOutcome.Issue.Builder
-
- Enclosing class:
- OperationOutcome.Issue
public static class OperationOutcome.Issue.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 OperationOutcome.Issue
build()
Build theOperationOutcome.Issue
OperationOutcome.Issue.Builder
code(IssueType code)
Describes the type of the issue.OperationOutcome.Issue.Builder
details(CodeableConcept details)
Additional details about the error.OperationOutcome.Issue.Builder
diagnostics(java.lang.String diagnostics)
Convenience method for settingdiagnostics
.OperationOutcome.Issue.Builder
diagnostics(String diagnostics)
Additional diagnostic information about the issue.OperationOutcome.Issue.Builder
expression(java.lang.String... expression)
Convenience method for settingexpression
.OperationOutcome.Issue.Builder
expression(java.util.Collection<String> expression)
A [simple subset of FHIRPath](fhirpath.html#simple) limited to element names, repetition indicators and the default child accessor that identifies one of the elements in the resource that caused this issue to be raised.OperationOutcome.Issue.Builder
expression(String... expression)
A [simple subset of FHIRPath](fhirpath.html#simple) limited to element names, repetition indicators and the default child accessor that identifies one of the elements in the resource that caused this issue to be raised.OperationOutcome.Issue.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.OperationOutcome.Issue.Builder
extension(Extension... extension)
May be used to represent additional information that is not part of the basic definition of the element.protected OperationOutcome.Issue.Builder
from(OperationOutcome.Issue issue)
OperationOutcome.Issue.Builder
id(java.lang.String id)
Unique id for the element within a resource (for internal references).OperationOutcome.Issue.Builder
location(java.lang.String... location)
Convenience method for settinglocation
.OperationOutcome.Issue.Builder
location(java.util.Collection<String> location)
This element is deprecated because it is XML specific.OperationOutcome.Issue.Builder
location(String... location)
This element is deprecated because it is XML specific.OperationOutcome.Issue.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.OperationOutcome.Issue.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.OperationOutcome.Issue.Builder
severity(IssueSeverity severity)
Indicates whether the issue indicates a variation from successful processing.protected void
validate(OperationOutcome.Issue issue)
-
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 OperationOutcome.Issue.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 OperationOutcome.Issue.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 OperationOutcome.Issue.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 OperationOutcome.Issue.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 OperationOutcome.Issue.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
-
severity
public OperationOutcome.Issue.Builder severity(IssueSeverity severity)
Indicates whether the issue indicates a variation from successful processing.This element is required.
- Parameters:
severity
- fatal | error | warning | information- Returns:
- A reference to this Builder instance
-
code
public OperationOutcome.Issue.Builder code(IssueType code)
Describes the type of the issue. The system that creates an OperationOutcome SHALL choose the most applicable code from the IssueType value set, and may additional provide its own code for the error in the details element.This element is required.
- Parameters:
code
- Error or warning code- Returns:
- A reference to this Builder instance
-
details
public OperationOutcome.Issue.Builder details(CodeableConcept details)
Additional details about the error. This may be a text description of the error or a system code that identifies the error.- Parameters:
details
- Additional details about the error- Returns:
- A reference to this Builder instance
-
diagnostics
public OperationOutcome.Issue.Builder diagnostics(java.lang.String diagnostics)
Convenience method for settingdiagnostics
.- Parameters:
diagnostics
- Additional diagnostic information about the issue- Returns:
- A reference to this Builder instance
- See Also:
diagnostics(org.linuxforhealth.fhir.model.type.String)
-
diagnostics
public OperationOutcome.Issue.Builder diagnostics(String diagnostics)
Additional diagnostic information about the issue.- Parameters:
diagnostics
- Additional diagnostic information about the issue- Returns:
- A reference to this Builder instance
-
location
public OperationOutcome.Issue.Builder location(java.lang.String... location)
Convenience method for settinglocation
.Adds new element(s) to the existing list. If any of the elements are null, calling
build()
will fail.- Parameters:
location
- Deprecated: Path of element(s) related to issue- Returns:
- A reference to this Builder instance
- See Also:
#location(org.linuxforhealth.fhir.model.type.String)
-
location
public OperationOutcome.Issue.Builder location(String... location)
This element is deprecated because it is XML specific. It is replaced by issue.expression, which is format independent, and simpler to parse.For resource issues, this will be a simple XPath limited to element names, repetition indicators and the default child accessor that identifies one of the elements in the resource that caused this issue to be raised. For HTTP errors, will be "http." + the parameter name.
Adds new element(s) to the existing list. If any of the elements are null, calling
build()
will fail.- Parameters:
location
- Deprecated: Path of element(s) related to issue- Returns:
- A reference to this Builder instance
-
location
public OperationOutcome.Issue.Builder location(java.util.Collection<String> location)
This element is deprecated because it is XML specific. It is replaced by issue.expression, which is format independent, and simpler to parse.For resource issues, this will be a simple XPath limited to element names, repetition indicators and the default child accessor that identifies one of the elements in the resource that caused this issue to be raised. For HTTP errors, will be "http." + the parameter name.
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:
location
- Deprecated: Path of element(s) related to issue- Returns:
- A reference to this Builder instance
- Throws:
java.lang.NullPointerException
- If the passed collection is null
-
expression
public OperationOutcome.Issue.Builder expression(java.lang.String... expression)
Convenience method for settingexpression
.Adds new element(s) to the existing list. If any of the elements are null, calling
build()
will fail.- Parameters:
expression
- FHIRPath of element(s) related to issue- Returns:
- A reference to this Builder instance
- See Also:
#expression(org.linuxforhealth.fhir.model.type.String)
-
expression
public OperationOutcome.Issue.Builder expression(String... expression)
A [simple subset of FHIRPath](fhirpath.html#simple) limited to element names, repetition indicators and the default child accessor that identifies one of the elements in the resource that caused this issue to be raised.Adds new element(s) to the existing list. If any of the elements are null, calling
build()
will fail.- Parameters:
expression
- FHIRPath of element(s) related to issue- Returns:
- A reference to this Builder instance
-
expression
public OperationOutcome.Issue.Builder expression(java.util.Collection<String> expression)
A [simple subset of FHIRPath](fhirpath.html#simple) limited to element names, repetition indicators and the default child accessor that identifies one of the elements in the resource that caused this issue to be raised.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:
expression
- FHIRPath of element(s) related to issue- Returns:
- A reference to this Builder instance
- Throws:
java.lang.NullPointerException
- If the passed collection is null
-
build
public OperationOutcome.Issue build()
- Specified by:
build
in interfaceBuilder<Element>
- Specified by:
build
in classBackboneElement.Builder
- Returns:
- An immutable object of type
OperationOutcome.Issue
- Throws:
java.lang.IllegalStateException
- if the current state cannot be built into a valid Issue per the base specification
-
validate
protected void validate(OperationOutcome.Issue issue)
-
from
protected OperationOutcome.Issue.Builder from(OperationOutcome.Issue issue)
-
-