oracle.hsgbu.hdr.hl7.rim.factories

Class EntityFactory

java.lang.Object

oracle.hsgbu.hdr.hl7.rim.factories.EntityFactory

public abstract class EntityFactory
extends Object

Factory for creating RIM Entity objects. The behavior of this factory varies depending on whether or not a ServiceLocator is supplied. If a ServiceLocator is supplied, then the factories will assign an 'internal identifier' with the root specified by OIDService.getOID(OIDService.INTERNAL_ROOT) and a sequence generated extension text to every RIM object created with a newX method below. If no ServiceLocator is supplied, then allocation of the internal identifier is defered until RimService.submit(). In this case no roundtrips will every be performed by this class.

Constructor Summary

Constructors

Constructor and Description
EntityFactory()

Method Summary

Modifier and Type	Method and Description
static EntityFactory	getInstance() Used by services to create an Instance of the EntityFactory.
abstract Entity	makeReference(ReferenceModifier modifier, CS entityClass, CE code, CS determiner, SET<II> id, int versionNumber) Creates a reference to an object that is assumed to already exist in HDR.
abstract NonPersonLivingSubject	newAnimal(CE code, CS determiner, SET<II> id) ANM (animal) A living subject from the animal kingdom.
abstract Device	newCertificateRepresentation(CE code, CS determiner, SET<II> id) CER (certificate representation) A physical artifact that stores information about the granting of authorization.
abstract Material	newChemicalSubstance(CE code, CS determiner, SET<II> id) CHEM (chemical substance) A substance that is fully defined by an organic or inorganic chemical formula, includes mixtures of other chemical substances.
abstract Place	newCity(CE code, CS determiner, SET<II> id) CITY (city or town) The territory of a city, town or other municipality.
abstract Container	newContainer(CE code, CS determiner, SET<II> id) CONT (container) A container of other entities.
abstract Place	newCountry(CE code, CS determiner, SET<II> id) COUNTRY (country) The territory of a sovereign nation.
abstract Place	newCounty(CE code, CS determiner, SET<II> id) COUNTY (county or parish) The territory of a county, parish or other division of a state or province.
abstract Device	newDevice(CE code, CS determiner, SET<II> id) DEV (device) A subtype of ManufacturedMaterial used in an activity, without being substantially changed through that activity.
abstract Entity	newEntity(CS entityClass, CE code, CS determiner, SET<II> id) Used by applications where the class is passed in rather than determined Programmatically.
abstract Material	newFood(CE code, CS determiner, SET<II> id) FOOD (food) Naturally occurring, processed or manufactured entities that are primarily used as food for humans and animals.
abstract Entity	newGroup(CE code, CS determiner, SET<II> id) GROUP (group) Any grouping of entities that are not considered resources.
abstract Entity	newHealthChart(CE code, CS determiner, SET<II> id) HCE (health chart entity) a health chart included to serve as a document receiving entity in the management of medical records.
abstract Container	newHolder(CE code, CS determiner, SET<II> id) HOLD (holder) A type of container that can hold other containers or other holders.
abstract Device	newImagingModality(CE code, CS determiner, SET<II> id) MODDV (imaging modality) Class to contain unique attributes of diagnostic imaging equipment.
abstract LanguageCommunication	newLanguageCommunication() Creates a LanguageCommunication object.
abstract LivingSubject	newLivingSubject(CE code, CS determiner, SET<II> id) LIV (living subject) Anything that essentially has the property of life, independent of current state (a dead human corpse is still essentially a living subject).
abstract ManufacturedMaterial	newManufacturedMaterial(CE code, CS determiner, SET<II> id) MMAT (manufactured material) Corresponds to the ManufacturedMaterial class.
abstract Material	newMaterial(CE code, CS determiner, SET<II> id) MAT (material) Anything that has extension in space and mass, may be of living or non-living origin.
abstract NonPersonLivingSubject	newMicroorganism(CE code, CS determiner, SET<II> id) MIC (microorganism) All single celled living organisms including protozoa, bacteria, yeast, viruses, etc.
abstract Organization	newNation(CE code, CS determiner, SET<II> id) NAT (Nation) A politically organized body of people bonded by territory, culture, or ethnicity, having sovereignty (to a certain extent) granted by other states (enclosing or neighboring states).
abstract NonPersonLivingSubject	newNonPersonLivingSubject(CE code, CS determiner, SET<II> id) NLIV (non-person living subject) A living subject that is not a person.
abstract Organization	newOrganization(CE code, CS determiner, SET<II> id) ORG (organization) A social or legal structure formed by human beings.
abstract Person	newPerson(CE code, CS determiner, SET<II> id) PSN (Person) A living subject of the species homo sapiens.
abstract Place	newPlace(CE code, CS determiner, SET<II> id) PLC (place) A physical place or site with its containing structure.
abstract NonPersonLivingSubject	newPlant(CE code, CS determiner, SET<II> id) PLNT (plant) A living subject from the order of plants.
abstract Place	newProvince(CE code, CS determiner, SET<II> id) PROVINCE (state or province) The territory of a state, province, department or other division of a sovereign country.
abstract Organization	newPublicInstitution(CE code, CS determiner, SET<II> id) PUB (public institution) An agency of the people of a state often assuming some authority over a certain matter.
abstract Entity	newResourceGroup(CE code, CS determiner, SET<II> id) RGRP (group) A grouping of resources (personnel, material, or places) to be used for scheduling purposes.
abstract Organization	newState(CE code, CS determiner, SET<II> id) STATE (State) A politically organized body of people bonded by territory, culture, or ethnicity, having sovereignty (to a certain extent) granted by other states (enclosing or neighboring states).

Methods inherited from class java.lang.Object

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

Constructor Detail

EntityFactory

public EntityFactory()

Method Detail

getInstance

public static EntityFactory getInstance()

Used by services to create an Instance of the EntityFactory.

Returns:

EntityFactory

newEntity

public abstract Entity newEntity(CS entityClass,
                                 CE code,
                                 CS determiner,
                                 SET<II> id)
                          throws HDRRimException

Used by applications where the class is passed in rather than determined Programmatically. Functionally identical to the individual class-specific factory methods except that the returned class may have to be cast to the specific subclass.

Parameters:

entityClass - EntityClass . This is a mandatory parameter

code - Entity Code for the Entity

determiner - EntityDeterminer. This is a mandatory parameter

id - Identification of the Entity, may be null. However, HDR will always generate an internal identifier. The II is unique across a broad class (Act, Entity, non-owned Role) rather than across the finer grained classes of HL7.

Returns:

The Entity created

Throws:

HDRRimException - when the entityClass is passed as null .

HDRRimException - when the determiner is passed as null .

HDRRimException - when the id passed is same as INTERNAL_ROOT.

newHealthChart

public abstract Entity newHealthChart(CE code,
                                      CS determiner,
                                      SET<II> id)
                               throws HDRRimException

HCE (health chart entity) a health chart included to serve as a document receiving entity in the management of medical records.

Parameters:

code - Entity Code for the HealthChart

determiner - EntityDeterminer. This is a mandatory parameter

id - Identification of the HealthChart, may be null. However, HDR will always generate an internal identifier. The II is unique across a broad class (Act, Entity, non-owned Role) rather than across the finer grained classes of HL7.

Returns:

The HealthChart created

Throws:

HDRRimException - when the determiner is passed as null .

HDRRimException - when the id passed is same as INTERNAL_ROOT.

See Also:

EntityClass.HCE

newOrganization

public abstract Organization newOrganization(CE code,
                                             CS determiner,
                                             SET<II> id)
                                      throws HDRRimException

ORG (organization) A social or legal structure formed by human beings.

Parameters:

code - Entity Code for the Organization

determiner - EntityDeterminer. This is a mandatory parameter

id - Identification of the Organization, may be null. However, HDR will always generate an internal identifier. The II is unique across a broad class (Act, Entity, non-owned Role) rather than across the finer grained classes of HL7.

Returns:

The Organization created

Throws:

HDRRimException - when the determiner is passed as null .

HDRRimException - when the id passed is same as INTERNAL_ROOT.

See Also:

EntityClass.ORG

newPublicInstitution

public abstract Organization newPublicInstitution(CE code,
                                                  CS determiner,
                                                  SET<II> id)
                                           throws HDRRimException

PUB (public institution) An agency of the people of a state often assuming some authority over a certain matter. Includes government, governmental agencies, associations.

Parameters:

code - Entity Code for the PublicInstitution

determiner - EntityDeterminer. This is a mandatory parameter

id - Identification of the PublicInstitution, may be null. However, HDR will always generate an internal identifier. The II is unique across a broad class (Act, Entity, non-owned Role) rather than across the finer grained classes of HL7.

Returns:

The PublicInstitution created.

Throws:

HDRRimException - when the determiner is passed as null .

HDRRimException - when the id passed is same as INTERNAL_ROOT.

See Also:

EntityClass.PUB

newNation

public abstract Organization newNation(CE code,
                                       CS determiner,
                                       SET<II> id)
                                throws HDRRimException

NAT (Nation) A politically organized body of people bonded by territory, culture, or ethnicity, having sovereignty (to a certain extent) granted by other states (enclosing or neighboring states). This includes countries (nations), provinces (example, one of the United States of America or a French departement), counties or municipalities. Refine using, e.g., ISO country codes, FIPS-PUB state codes, etc.

Parameters:

code - Entity Code for the State

determiner - EntityDeterminer. This is a mandatory parameter.

id - Identification of the Nation, may be null. However, HDR will always generate an internal identifier. The II is unique across a broad class (Act, Entity, non-owned Role) rather than across the finer grained classes of HL7.

Returns:

The State created.

Throws:

HDRRimException - when the determiner is passed as null .

HDRRimException - when the id passed is same as INTERNAL_ROOT.

See Also:

EntityClass.NAT

newState

public abstract Organization newState(CE code,
                                      CS determiner,
                                      SET<II> id)
                               throws HDRRimException

STATE (State) A politically organized body of people bonded by territory, culture, or ethnicity, having sovereignty (to a certain extent) granted by other states (enclosing or neighboring states). This includes countries (nations), provinces (example, one of the United States of America or a French departement), counties or municipalities. Refine using, e.g., ISO country codes, FIPS-PUB state codes, etc.

Parameters:

code - Entity Code for the State

determiner - EntityDeterminer. This is a mandatory parameter

id - Identification of the State, may be null. However, HDR will always generate an internal identifier. The II is unique across a broad class (Act, Entity, non-owned Role) rather than across the finer grained classes of HL7.

Returns:

The State created

Throws:

HDRRimException - when the determiner is passed as null .

HDRRimException - when the id passed is same as INTERNAL_ROOT.

See Also:

EntityClass.STATE

newPerson

public abstract Person newPerson(CE code,
                                 CS determiner,
                                 SET<II> id)
                          throws HDRRimException

PSN (Person) A living subject of the species homo sapiens.

Parameters:

code - Entity Code for the Person

determiner - EntityDeterminer. This is a mandatory parameter

id - Identification of the Person, may be null. However, HDR will always generate an internal identifier. The II is unique across a broad class (Act, Entity, non-owned Role) rather than across the finer grained classes of HL7.

Returns:

The Person created

Throws:

HDRRimException - when the determiner is passed as null .

HDRRimException - when the id passed is same as INTERNAL_ROOT.

See Also:

EntityClass.PSN

newLivingSubject

public abstract LivingSubject newLivingSubject(CE code,
                                               CS determiner,
                                               SET<II> id)
                                        throws HDRRimException

LIV (living subject) Anything that essentially has the property of life, independent of current state (a dead human corpse is still essentially a living subject).

Parameters:

code - Entity Code for the LivingSubject

determiner - EntityDeterminer. This is a mandatory parameter

id - Identification of the LivingSubject, may be null. However, HDR will always generate an internal identifier. The II is unique across a broad class (Act, Entity, non-owned Role) rather than across the finer grained classes of HL7.

Returns:

The LivingSubject created

Throws:

HDRRimException - when the determiner is passed as null .

HDRRimException - when the id passed is same as INTERNAL_ROOT.

See Also:

EntityClass.LIV

newNonPersonLivingSubject

public abstract NonPersonLivingSubject newNonPersonLivingSubject(CE code,
                                                                 CS determiner,
                                                                 SET<II> id)
                                                          throws HDRRimException

NLIV (non-person living subject) A living subject that is not a person. Example, animal (ANM), plant (PLNT), and microorganism (MIC).

Parameters:

code - Entity Code for the NonPersonLivingSubject

determiner - EntityDeterminer. This is a mandatory parameter

id - Identification of the NonPersonLivingSubject, may be null. However, HDR will always generate an internal identifier. The II is unique across a broad class (Act, Entity, non-owned Role) rather than across the finer grained classes of HL7.

Returns:

The NonPersonLivingSubject created

Throws:

HDRRimException - when the determiner is passed as null .

HDRRimException - when the id passed is same as INTERNAL_ROOT.

See Also:

EntityClass.NLIV

newAnimal

public abstract NonPersonLivingSubject newAnimal(CE code,
                                                 CS determiner,
                                                 SET<II> id)
                                          throws HDRRimException

ANM (animal) A living subject from the animal kingdom.

Parameters:

code - Entity Code for the Animal

determiner - EntityDeterminer. This is a mandatory parameter

id - Identification of the Animal, may be null. However, HDR will always generate an internal identifier. The II is unique across a broad class (Act, Entity, non-owned Role) rather than across the finer grained classes of HL7.

Returns:

The Animal created

Throws:

HDRRimException - when the determiner is passed as null .

HDRRimException - when the id passed is same as INTERNAL_ROOT.

See Also:

EntityClass.ANM

newMicroorganism

public abstract NonPersonLivingSubject newMicroorganism(CE code,
                                                        CS determiner,
                                                        SET<II> id)
                                                 throws HDRRimException

MIC (microorganism) All single celled living organisms including protozoa, bacteria, yeast, viruses, etc.

Parameters:

code - Entity Code for the Microorganism

determiner - EntityDeterminer. This is a mandatory parameter

id - Identification of the Microorganism, may be null. However, HDR will always generate an internal identifier. The II is unique across a broad class (Act, Entity, non-owned Role) rather than across the finer grained classes of HL7.

Returns:

The Microorganism created

Throws:

HDRRimException - when the determiner is passed as null .

HDRRimException - when the id passed is same as INTERNAL_ROOT.

See Also:

EntityClass.MIC

newPlant

public abstract NonPersonLivingSubject newPlant(CE code,
                                                CS determiner,
                                                SET<II> id)
                                         throws HDRRimException

PLNT (plant) A living subject from the order of plants.

Parameters:

code - Entity Code for the Plant

determiner - EntityDeterminer. This is a mandatory parameter

id - Identification of the Plant, may be null. However, HDR will always generate an internal identifier. The II is unique across a broad class (Act, Entity, non-owned Role) rather than across the finer grained classes of HL7.

Returns:

The Plant created

Throws:

HDRRimException - when the determiner is passed as null .

HDRRimException - when the id passed is same as INTERNAL_ROOT.

See Also:

EntityClass.PLNT

newMaterial

public abstract Material newMaterial(CE code,
                                     CS determiner,
                                     SET<II> id)
                              throws HDRRimException

MAT (material) Anything that has extension in space and mass, may be of living or non-living origin.

Parameters:

code - Entity Code for the Material

determiner - EntityDeterminer. This is a mandatory parameter

id - Identification of the Material, may be null. However, HDR will always generate an internal identifier. The II is unique across a broad class (Act, Entity, non-owned Role) rather than across the finer grained classes of HL7.

Returns:

The Material created

Throws:

HDRRimException - when the determiner is passed as null .

HDRRimException - when the id passed is same as INTERNAL_ROOT.

See Also:

EntityClass.MAT

newChemicalSubstance

public abstract Material newChemicalSubstance(CE code,
                                              CS determiner,
                                              SET<II> id)
                                       throws HDRRimException

CHEM (chemical substance) A substance that is fully defined by an organic or inorganic chemical formula, includes mixtures of other chemical substances. Refine using, example, IUPAC codes.

Parameters:

code - Entity Code for the ChemicalSubstance

determiner - EntityDeterminer. This is a mandatory parameter

id - Identification of the ChemicalSubstance, may be null. However, HDR will always generate an internal identifier. The II is unique across a broad class (Act, Entity, non-owned Role) rather than across the finer grained classes of HL7.

Returns:

The ChemicalSubstance created

Throws:

HDRRimException - when the determiner is passed as null .

HDRRimException - when the id passed is same as INTERNAL_ROOT.

See Also:

EntityClass.CHEM

newFood

public abstract Material newFood(CE code,
                                 CS determiner,
                                 SET<II> id)
                          throws HDRRimException

FOOD (food) Naturally occurring, processed or manufactured entities that are primarily used as food for humans and animals.

Parameters:

code - Entity Code for the Food

determiner - EntityDeterminer. This is a mandatory parameter

id - Identification of the Food, may be null. However, HDR will always generate an internal identifier. The II is unique across a broad class (Act, Entity, non-owned Role) rather than across the finer grained classes of HL7.

Returns:

The Food created

Throws:

HDRRimException - when the determiner is passed as null .

HDRRimException - when the id passed is same as INTERNAL_ROOT.

See Also:

EntityClass.FOOD

newManufacturedMaterial

public abstract ManufacturedMaterial newManufacturedMaterial(CE code,
                                                             CS determiner,
                                                             SET<II> id)
                                                      throws HDRRimException

MMAT (manufactured material) Corresponds to the ManufacturedMaterial class.

Parameters:

code - Entity Code for the ManufacturedMaterial

determiner - EntityDeterminer. This is a mandatory parameter

id - Identification of the ManufacturedMaterial, may be null. However, HDR will always generate an internal identifier. The II is unique across a broad class (Act, Entity, non-owned Role) rather than across the finer grained classes of HL7.

Returns:

The ManufacturedMaterial created

Throws:

HDRRimException - when the determiner is passed as null .

HDRRimException - when the id passed is same as INTERNAL_ROOT.

See Also:

EntityClass.MMAT

newContainer

public abstract Container newContainer(CE code,
                                       CS determiner,
                                       SET<II> id)
                                throws HDRRimException

CONT (container) A container of other entities.

Parameters:

code - Entity Code for the Container

determiner - EntityDeterminer. This is a mandatory parameter

id - Identification of the Container, may be null. However, HDR will always generate an internal identifier. The II is unique across a broad class (Act, Entity, non-owned Role) rather than across the finer grained classes of HL7.

Returns:

The Container created

Throws:

HDRRimException - when the determiner is passed as null .

HDRRimException - when the id passed is same as INTERNAL_ROOT.

See Also:

EntityClass.CONT

newHolder

public abstract Container newHolder(CE code,
                                    CS determiner,
                                    SET<II> id)
                             throws HDRRimException

HOLD (holder) A type of container that can hold other containers or other holders.

Parameters:

code - Entity Code for the Holder

determiner - EntityDeterminer. This is a mandatory parameter

id - Identification of the Holder, may be null. However, HDR will always generate an internal identifier. The II is unique across a broad class (Act, Entity, non-owned Role) rather than across the finer grained classes of HL7.

Returns:

The Holder created

Throws:

HDRRimException - when the determiner is passed as null .

HDRRimException - when the id passed is same as INTERNAL_ROOT.

See Also:

EntityClass.HOLD

newDevice

public abstract Device newDevice(CE code,
                                 CS determiner,
                                 SET<II> id)
                          throws HDRRimException

DEV (device) A subtype of ManufacturedMaterial used in an activity, without being substantially changed through that activity. The kind of device is identified by the code attribute inherited from Entity.

Usage: This includes durable (reusable) medical equipment as well as disposable equipment.

Parameters:

code - Entity Code for the Device

determiner - EntityDeterminer. This is a mandatory parameter

id - Identification of the Device, may be null. However, HDR will always generate an internal identifier. The II is unique across a broad class (Act, Entity, non-owned Role) rather than across the finer grained classes of HL7.

Returns:

The Device created

Throws:

HDRRimException - when the determiner is passed as null .

HDRRimException - when the id passed is same as INTERNAL_ROOT.

See Also:

EntityClass.DEV

newCertificateRepresentation

public abstract Device newCertificateRepresentation(CE code,
                                                    CS determiner,
                                                    SET<II> id)
                                             throws HDRRimException

CER (certificate representation) A physical artifact that stores information about the granting of authorization.

Parameters:

code - Entity Code for the CertificateRepresentation

determiner - EntityDeterminer. This is a mandatory parameter

id - Identification of the CertificateRepresentation, may be null. However, HDR will always generate an internal identifier. The II is unique across a broad class (Act, Entity, non-owned Role) rather than across the finer grained classes of HL7.

Returns:

The CertificateRepresentation created

Throws:

HDRRimException - when the determiner is passed as null .

HDRRimException - when the id passed is same as INTERNAL_ROOT.

See Also:

EntityClass.CER

newImagingModality

public abstract Device newImagingModality(CE code,
                                          CS determiner,
                                          SET<II> id)
                                   throws HDRRimException

MODDV (imaging modality) Class to contain unique attributes of diagnostic imaging equipment.

Parameters:

code - Entity Code for the ImagingModality

determiner - EntityDeterminer. This is a mandatory parameter

id - Identification of the ImagingModality, may be null. However, HDR will always generate an internal identifier. The II is unique across a broad class (Act, Entity, non-owned Role) rather than across the finer grained classes of HL7.

Returns:

The ImagingModality created

Throws:

HDRRimException - when the determiner is passed as null .

HDRRimException - when the id passed is same as INTERNAL_ROOT.

See Also:

EntityClass.MODDV

newPlace

public abstract Place newPlace(CE code,
                               CS determiner,
                               SET<II> id)
                        throws HDRRimException

PLC (place) A physical place or site with its containing structure. May be natural or man-made. The geographic position of a place may or may not be constant.

Parameters:

code - Entity Code for the Place

determiner - EntityDeterminer. This is a mandatory parameter

id - Identification of the Place, may be null. However, HDR will always generate an internal identifier. The II is unique across a broad class (Act, Entity, non-owned Role) rather than across the finer grained classes of HL7.

Returns:

The Place created

Throws:

HDRRimException - when the determiner is passed as null .

HDRRimException - when the id passed is same as INTERNAL_ROOT.

See Also:

EntityClass.PLC

newCity

public abstract Place newCity(CE code,
                              CS determiner,
                              SET<II> id)
                       throws HDRRimException

CITY (city or town) The territory of a city, town or other municipality.

Parameters:

code - Entity Code for the City

determiner - EntityDeterminer. This is a mandatory parameter

id - Identification of the City, may be null. However, HDR will always generate an internal identifier. The II is unique across a broad class (Act, Entity, non-owned Role) rather than across the finer grained classes of HL7.

Returns:

The City created

Throws:

HDRRimException - when the determiner is passed as null .

HDRRimException - when the id passed is same as INTERNAL_ROOT.

See Also:

EntityClass.CITY

newCountry

public abstract Place newCountry(CE code,
                                 CS determiner,
                                 SET<II> id)
                          throws HDRRimException

COUNTRY (country) The territory of a sovereign nation.

Parameters:

code - Entity Code for the Country

determiner - EntityDeterminer. This is a mandatory parameter

id - Identification of the Country, may be null. However, HDR will always generate an internal identifier. The II is unique across a broad class (Act, Entity, non-owned Role) rather than across the finer grained classes of HL7.

Returns:

The Country created

Throws:

HDRRimException - when the determiner is passed as null .

HDRRimException - when the id passed is same as INTERNAL_ROOT.

See Also:

EntityClass.COUNTRY

newCounty

public abstract Place newCounty(CE code,
                                CS determiner,
                                SET<II> id)
                         throws HDRRimException

COUNTY (county or parish) The territory of a county, parish or other division of a state or province.

Parameters:

code - Entity Code for the County

determiner - EntityDeterminer. This is a mandatory parameter

id - Identification of the County, may be null. However, HDR will always generate an internal identifier. The II is unique across a broad class (Act, Entity, non-owned Role) rather than across the finer grained classes of HL7.

Returns:

The County created

Throws:

HDRRimException - when the determiner is passed as null .

HDRRimException - when the id passed is same as INTERNAL_ROOT.

See Also:

EntityClass.COUNTY

newProvince

public abstract Place newProvince(CE code,
                                  CS determiner,
                                  SET<II> id)
                           throws HDRRimException

PROVINCE (state or province) The territory of a state, province, department or other division of a sovereign country.

Parameters:

code - Entity Code for the Province

determiner - EntityDeterminer. This is a mandatory parameter

id - Identification of the Province, may be null. However, HDR will always generate an internal identifier. The II is unique across a broad class (Act, Entity, non-owned Role) rather than across the finer grained classes of HL7.

Returns:

The Province created

Throws:

HDRRimException - when the determiner is passed as null .

HDRRimException - when the id passed is same as INTERNAL_ROOT.

See Also:

EntityClass.PROVINCE

newResourceGroup

public abstract Entity newResourceGroup(CE code,
                                        CS determiner,
                                        SET<II> id)
                                 throws HDRRimException

RGRP (group) A grouping of resources (personnel, material, or places) to be used for scheduling purposes. May be a pool of like-type resources, a team, or combination of personnel, material and places.

Parameters:

code - Entity Code for the ResourceGroup

determiner - EntityDeterminer. This is a mandatory parameter

id - Identification of the ResourceGroup, may be null. However, HDR will always generate an internal identifier. The II is unique across a broad class (Act, Entity, non-owned Role) rather than across the finer grained classes of HL7.

Returns:

The ResourceGroup created

Throws:

HDRRimException - when the determiner is passed as null .

HDRRimException - when the id passed is same as INTERNAL_ROOT.

See Also:

EntityClass.RGRP

newGroup

public abstract Entity newGroup(CE code,
                                CS determiner,
                                SET<II> id)
                         throws HDRRimException

GROUP (group) Any grouping of entities that are not considered resources. This entity particularly applies to heterogonous collections of entities, such as inventory, which may include many kinds of materials, manufactured or otherwise. This entity can also represent groups of animals, such as flock and herd, and group of people, such as coworkers and military. This entity would typically scope one or more MBR roles played by the members of the group. The EntityCode can further specify the type of group.

Parameters:

code - Entity Code for the Group

determiner - EntityDeterminer. This is a mandatory parameter.

id - Identification of the Group, may be null. However, HDR will always generate an internal identifier. The II is unique across a broad class (Act, Entity, non-owned Role) rather than across the finer grained classes of HL7.

Returns:

The Group created

Throws:

HDRRimException - when the determiner is passed as null .

HDRRimException - when the id passed is same as INTERNAL_ROOT.

See Also:

EntityClass.GROUP

newLanguageCommunication

public abstract LanguageCommunication newLanguageCommunication()
                                                        throws HDRRimException

Creates a LanguageCommunication object.

Returns:

The LanguageCommunication created

Throws:

HDRRimException - when the determiner is passed as null .

HDRRimException - when the id passed is same as INTERNAL_ROOT.

makeReference

public abstract Entity makeReference(ReferenceModifier modifier,
                                     CS entityClass,
                                     CE code,
                                     CS determiner,
                                     SET<II> id,
                                     int versionNumber)
                              throws HDRRimException

Creates a reference to an object that is assumed to already exist in HDR. Only the first and last argument are mandatory.

Parameters:

modifier - Controls the behavior of the reference when submitted. Possible values include:

• MustExist - The referenced object must be found in the database. All but the class and II are ignored.
• CreateIf - If the object does not exist, the object is used to create the object in the database. Otherwise, the contents of the object are ignored.
• CreateOrOverlay - If the object does not exist, it is created. If it does exist, it is updated thus incrementing the version number of the object. Any attributes not set in the object will also be cleared in the new version. Use this variation to simulate IMP behavior.
• CreateOrUpdate - If the object does not already exist, it is created. If it does exist it will be updated thus incrementing the current version of the object. Any attributes not set in the object will be retained from the existing database object. Use this variation to update one or more attributes without having to query the existing object first. In the case of repeating attributes, the list supplied in the reference object are added to the list in the database record. Where there are duplicates, the "new" entries replace the old attribute. If more control is needed, the application should query the object and call newVersion.

Overlay - Identical to CreateOrOverlay, but will not create an object that does not already exist.

Update - As for CreateOrUpdate, but will not create an object that does not already exist.

entityClass - Class Code of the Entity. This parameter must be specified for CreateIf, CreateOrOverlay, CreateOrUpdate, and Overlay modifiers.

determiner - of the Entity. This parameter must be specified for CreateIf, CreateOrOverlay, CreateOrUpdate, and Overlay modifiers.

code - entity code. This parameter may be null. However a null value may result in validation failures for Overlay or CreateOrOverlay references if an attempt is made to modify an object that has a code.

id - Identification of the position, which is mandatory and cannot be an empty set. The II is unique across a broad class (Act, Entity, non-owned Role) rather than across the finer grained classes of HL7.

versionNumber - Zero or a valid positive integer. If it is zero, then the current version will be used. For positive integer values the behavior will vary depending on the modifier. It is ignored for CREATE_IF references. For MUST_EXIST references, the specified versionNumber must correspond to a version in the database. For UPDATE or OVERLAY references the specified versionNumber must correspond to a version in the database and be the current version at the time of submission. CREATE_OR_OVERLAY and CREATE_OR_UPDATE references will behave like CREATE_IF or UPDATE/OVERLAY depending on whether an object exists in the database.

Returns:

The Entity object which is being referenced here. This can be downcasted to the proper sub class of Entity based on the class code passed.

Throws:

HDRRimException