Package com.ibm.fhir.model.resource

Class SubstanceSpecification.Name

java.lang.Object

com.ibm.fhir.model.visitor.AbstractVisitable

com.ibm.fhir.model.type.Element

com.ibm.fhir.model.type.BackboneElement

com.ibm.fhir.model.resource.SubstanceSpecification.Name

All Implemented Interfaces:

Visitable

Enclosing class:

SubstanceSpecification

public static class SubstanceSpecification.Name
extends BackboneElement

Names applicable to this substance.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SubstanceSpecification.Name.Builder
static class	SubstanceSpecification.Name.Official	Details of the official nature of this name.

Field Summary

Fields inherited from class com.ibm.fhir.model.type.BackboneElement

modifierExtension

Fields inherited from class com.ibm.fhir.model.type.Element

extension, hashCode, id

Method Summary

Modifier and Type	Method	Description
void	accept(String elementName, int elementIndex, Visitor visitor)	Accept a Visitor and invoke the appropriate visit methods.
static SubstanceSpecification.Name.Builder	builder()
boolean	equals(Object obj)
List<CodeableConcept>	getDomain()	The use context of this name for example if there is a different name a drug active ingredient as opposed to a food colour additive.
List<CodeableConcept>	getJurisdiction()	The jurisdiction where this name applies.
List<CodeableConcept>	getLanguage()	Language of the name.
String	getName()	The actual name.
List<SubstanceSpecification.Name.Official>	getOfficial()	Details of the official nature of this name.
Boolean	getPreferred()	If this is the preferred name for this substance.
List<Reference>	getSource()	Supporting literature.
CodeableConcept	getStatus()	The status of the name.
List<SubstanceSpecification.Name>	getSynonym()	A synonym of this name.
List<SubstanceSpecification.Name>	getTranslation()	A translation for this name.
CodeableConcept	getType()	Name type.
boolean	hasChildren()
int	hashCode()
SubstanceSpecification.Name.Builder	toBuilder()	Create a new Builder from the contents of this Element

Methods inherited from class com.ibm.fhir.model.type.BackboneElement

getModifierExtension

Methods inherited from class com.ibm.fhir.model.type.Element

as, getExtension, getId, hasValue, is

Methods inherited from class com.ibm.fhir.model.visitor.AbstractVisitable

accept, accept, accept, accept, accept, accept, accept, accept, accept, accept, accept, accept, accept, toString

Methods inherited from class java.lang.Object

clone, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.ibm.fhir.model.visitor.Visitable

accept, accept

Method Detail

getName

public String getName()

The actual name.

Returns:

An immutable object of type String that is non-null.

getType

public CodeableConcept getType()

Name type.

Returns:

An immutable object of type CodeableConcept that may be null.

getStatus

public CodeableConcept getStatus()

The status of the name.

Returns:

An immutable object of type CodeableConcept that may be null.

getPreferred

public Boolean getPreferred()

If this is the preferred name for this substance.

Returns:

An immutable object of type Boolean that may be null.

getLanguage

public List<CodeableConcept> getLanguage()

Language of the name.

Returns:

An unmodifiable list containing immutable objects of type CodeableConcept that may be empty.

getDomain

public List<CodeableConcept> getDomain()

The use context of this name for example if there is a different name a drug active ingredient as opposed to a food colour additive.

Returns:

An unmodifiable list containing immutable objects of type CodeableConcept that may be empty.

getJurisdiction

public List<CodeableConcept> getJurisdiction()

The jurisdiction where this name applies.

Returns:

An unmodifiable list containing immutable objects of type CodeableConcept that may be empty.

getSynonym

public List<SubstanceSpecification.Name> getSynonym()

A synonym of this name.

Returns:

An unmodifiable list containing immutable objects of type SubstanceSpecification.Name that may be empty.

getTranslation

public List<SubstanceSpecification.Name> getTranslation()

A translation for this name.

Returns:

An unmodifiable list containing immutable objects of type SubstanceSpecification.Name that may be empty.

getOfficial

public List<SubstanceSpecification.Name.Official> getOfficial()

Details of the official nature of this name.

Returns:

An unmodifiable list containing immutable objects of type SubstanceSpecification.Name.Official that may be empty.

getSource

public List<Reference> getSource()

Supporting literature.

Returns:

An unmodifiable list containing immutable objects of type Reference that may be empty.

hasChildren

public boolean hasChildren()

Overrides:

hasChildren in class BackboneElement

accept

public void accept(String elementName,
                   int elementIndex,
                   Visitor visitor)

Description copied from interface: Visitable

Accept a Visitor and invoke the appropriate visit methods. A typical implementation would look like this:

 if (visitor.preVisit(this)) {
     visitor.visitStart(elementName, elementIndex, this);
     if (visitor.visit(elementName, elementIndex, this)) {
         // visit children
     }
     visitor.visitEnd(elementName, elementIndex, this);
     visitor.postVisit(this);
 }
 

Specified by:

accept in interface Visitable

Specified by:

accept in class AbstractVisitable

Parameters:

elementName - the name of the element in the context of this visit

elementIndex - the index of the element in a list or -1 if it is not contained within a List

visitor - the visitor to use

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toBuilder

public SubstanceSpecification.Name.Builder toBuilder()

Description copied from class: Element

Create a new Builder from the contents of this Element

Specified by:

toBuilder in class BackboneElement

builder

public static SubstanceSpecification.Name.Builder builder()