Package org.hl7.fhir.r5.openehr

Class FOLDER

java.lang.Object

org.hl7.fhir.r5.model.Base

org.hl7.fhir.r5.model.LogicalBase

org.hl7.fhir.r5.openehr.Any

org.hl7.fhir.r5.openehr.PATHABLE

org.hl7.fhir.r5.openehr.LOCATABLE

org.hl7.fhir.r5.openehr.FOLDER

All Implemented Interfaces:

ca.uhn.fhir.model.api.IElement, Serializable, org.hl7.fhir.instance.model.api.IBase, org.hl7.fhir.instance.model.api.IBaseDatatype, org.hl7.fhir.instance.model.api.ICompositeType

public class FOLDER
extends LOCATABLE
implements org.hl7.fhir.instance.model.api.ICompositeType

The concept of a named folder. It is strongly recommended that the inherited attribute uid be populated in top-level (i.e. tree-root) FOLDER objects, using the UID copied from the object_id() of the uid field of the enclosing VERSION object. For example, the ORIGINAL_VERSION.uid 87284370-2D4B-4e3d-A3F3-F303D2F4F34B::uk.nhs.ehr1::2 would be copied to the uid field of the top FOLDER object.

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.hl7.fhir.r5.model.Base

Base.ProfileSource, Base.ValidationInfo, Base.ValidationMode, Base.ValidationReason

Field Summary

Fields

Modifier and Type	Field	Description
protected ITEM_STRUCTURE	details	Archetypable meta-data for FOLDER.
protected List<FOLDER>	foldersList	Sub-folders of this FOLDER.
protected List<OBJECT_REF>	itemsList	The list of references to other (usually) versioned objects logically in this folder.

Fields inherited from class org.hl7.fhir.r5.openehr.PATHABLE

archetype_details, archetype_node_id, feeder_audit, linksList, name, uid

Constructor Summary

Constructors

Constructor	Description
FOLDER()	Constructor

Method Summary

Modifier and Type	Method	Description
Base	addChild(String name)
FOLDER	addFolders()
FOLDER	addFolders(FOLDER t)
OBJECT_REF	addItems()
FOLDER	addItems(OBJECT_REF t)
FOLDER	copy()
void	copyValues(FOLDER dst)
boolean	equalsDeep(Base other_)
boolean	equalsShallow(Base other_)
String	fhirType()
ITEM_STRUCTURE	getDetails()
FOLDER	getFoldersFirstRep()
List<FOLDER>	getFoldersList()
OBJECT_REF	getItemsFirstRep()
List<OBJECT_REF>	getItemsList()
Property	getNamedProperty(int _hash, String _name, boolean _checkValid)
Base[]	getProperty(int hash, String name, boolean checkValid)
String[]	getTypesForProperty(int hash, String name)
boolean	hasDetails()
boolean	hasFolders()
boolean	hasItems()
boolean	isEmpty()
protected void	listChildren(List<Property> children)
Base	makeProperty(int hash, String name)
FOLDER	setDetails(ITEM_STRUCTURE value)
FOLDER	setFoldersList(List<FOLDER> theFolders)
FOLDER	setItemsList(List<OBJECT_REF> theItems)
Base	setProperty(int hash, String name, Base value)
Base	setProperty(String name, Base value)
protected FOLDER	typedCopy()

Methods inherited from class org.hl7.fhir.r5.openehr.LOCATABLE

copyValues

Methods inherited from class org.hl7.fhir.r5.openehr.PATHABLE

addLinks, addLinks, copyValues, getArchetype_details, getArchetype_node_id, getArchetype_node_idElement, getFeeder_audit, getLinksFirstRep, getLinksList, getName, getUid, hasArchetype_details, hasArchetype_node_id, hasArchetype_node_idElement, hasFeeder_audit, hasLinks, hasName, hasUid, setArchetype_details, setArchetype_node_id, setArchetype_node_idElement, setFeeder_audit, setLinksList, setName, setUid

Methods inherited from class org.hl7.fhir.r5.openehr.Any

copyValues

Methods inherited from class org.hl7.fhir.r5.model.LogicalBase

getFHIRPublicationVersion, getIdBase, setIdBase

Methods inherited from class org.hl7.fhir.r5.model.Base

addDefinition, addFormatCommentsPost, addFormatCommentsPre, addValidationMessage, canHavePrimitiveValue, children, clearUserData, compareDeep, compareDeep, compareDeep, compareDeep, compareValues, compareValues, copyFormatComments, copyUserData, copyValues, dateTimeValue, equals, executeFunction, getChildByName, getChildValueByName, getFormatCommentsPost, getFormatCommentsPre, getNamedProperty, getUserData, getUserInt, getUserString, getValidationInfo, getValidationMessages, getXhtml, hasFormatComment, hasFormatCommentPost, hasFormatCommentPre, hasPrimitiveValue, hasType, hasUserData, hasValidated, hasValidationInfo, hasValidationMessages, isBooleanPrimitive, isCopyUserData, isDateTime, isMetadataBased, isPrimitive, isResource, listChildrenByName, listChildrenByName, primitiveValue, removeChild, setCopyUserData, setUserData, setUserDataINN, setXhtml

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.hl7.fhir.instance.model.api.IBase

getFormatCommentsPost, getFormatCommentsPre, getUserData, hasFormatComment, setUserData

Field Details

itemsList

protected List<OBJECT_REF> itemsList

The list of references to other (usually) versioned objects logically in this folder.

foldersList

protected List<FOLDER> foldersList

Sub-folders of this FOLDER.

details

protected ITEM_STRUCTURE details

Archetypable meta-data for FOLDER.

Constructor Details

FOLDER

public FOLDER()

Constructor

Method Details

getItemsList

public List<OBJECT_REF> getItemsList()

Returns:

invalid reference

#items

(The list of references to other (usually) versioned objects logically in this folder.)

setItemsList

public FOLDER setItemsList(List<OBJECT_REF> theItems)

Returns:

Returns a reference to this for easy method chaining

hasItems

public boolean hasItems()

addItems

public OBJECT_REF addItems()

addItems

public FOLDER addItems(OBJECT_REF t)

getItemsFirstRep

public OBJECT_REF getItemsFirstRep()

Returns:

The first repetition of repeating field

invalid reference

#items

, creating it if it does not already exist {3}

getFoldersList

public List<FOLDER> getFoldersList()

Returns:

invalid reference

#folders

(Sub-folders of this FOLDER.)

setFoldersList

public FOLDER setFoldersList(List<FOLDER> theFolders)

Returns:

Returns a reference to this for easy method chaining

hasFolders

public boolean hasFolders()

addFolders

public FOLDER addFolders()

addFolders

public FOLDER addFolders(FOLDER t)

getFoldersFirstRep

public FOLDER getFoldersFirstRep()

Returns:

The first repetition of repeating field

invalid reference

#folders

, creating it if it does not already exist {3}

getDetails

public ITEM_STRUCTURE getDetails()

Returns:

details (Archetypable meta-data for FOLDER.)

hasDetails

public boolean hasDetails()

setDetails

public FOLDER setDetails(ITEM_STRUCTURE value)

Parameters:

value - details (Archetypable meta-data for FOLDER.)

listChildren

protected void listChildren(List<Property> children)

Overrides:

listChildren in class PATHABLE

getNamedProperty

public Property getNamedProperty(int _hash,
 String _name,
 boolean _checkValid)
                          throws org.hl7.fhir.exceptions.FHIRException

Overrides:

getNamedProperty in class PATHABLE

Throws:

org.hl7.fhir.exceptions.FHIRException

getProperty

public Base[] getProperty(int hash,
 String name,
 boolean checkValid)
                   throws org.hl7.fhir.exceptions.FHIRException

Overrides:

getProperty in class PATHABLE

Throws:

org.hl7.fhir.exceptions.FHIRException

setProperty

public Base setProperty(int hash,
 String name,
 Base value)
                 throws org.hl7.fhir.exceptions.FHIRException

Overrides:

setProperty in class PATHABLE

Throws:

org.hl7.fhir.exceptions.FHIRException

setProperty

public Base setProperty(String name,
 Base value)
                 throws org.hl7.fhir.exceptions.FHIRException

Overrides:

setProperty in class PATHABLE

Throws:

org.hl7.fhir.exceptions.FHIRException

makeProperty

public Base makeProperty(int hash,
 String name)
                  throws org.hl7.fhir.exceptions.FHIRException

Overrides:

makeProperty in class PATHABLE

Throws:

org.hl7.fhir.exceptions.FHIRException

getTypesForProperty

public String[] getTypesForProperty(int hash,
 String name)
                             throws org.hl7.fhir.exceptions.FHIRException

Overrides:

getTypesForProperty in class PATHABLE

Throws:

org.hl7.fhir.exceptions.FHIRException

addChild

public Base addChild(String name)
              throws org.hl7.fhir.exceptions.FHIRException

Overrides:

addChild in class PATHABLE

Throws:

org.hl7.fhir.exceptions.FHIRException

fhirType

public String fhirType()

Specified by:

fhirType in interface org.hl7.fhir.instance.model.api.IBase

Overrides:

fhirType in class LOCATABLE

Returns:

the FHIR type name of the instance (not the java class name)

copy

public FOLDER copy()

Specified by:

copy in class LOCATABLE

copyValues

public void copyValues(FOLDER dst)

typedCopy

protected FOLDER typedCopy()

equalsDeep

public boolean equalsDeep(Base other_)

Overrides:

equalsDeep in class PATHABLE

equalsShallow

public boolean equalsShallow(Base other_)

Overrides:

equalsShallow in class PATHABLE

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface org.hl7.fhir.instance.model.api.IBase

Overrides:

isEmpty in class PATHABLE