oracle.hsgbu.hdr.hl7.fwk

Interface Versioned

All Known Subinterfaces:

Access, Account, Act, Container, ContextStructure, ControlAct, Device, DeviceTask, DiagnosticImage, Diet, Document, Employee, Entity, FinancialContract, FinancialTransaction, InvoiceElement, LicensedEntity, LivingSubject, ManufacturedMaterial, Material, NonPersonLivingSubject, Observation, Organization, Patient, PatientEncounter, Person, Place, Procedure, PublicHealthCase, QualifiedEntity, QueryAct, Role, SubstanceAdministration, Supply, WorkingList

public interface Versioned

Provides version-related functionality for RIM objects. All acts, roles, entities and their subclasses are versioned. Specific versions of objects can be queried by using the version number.

Method Summary

Modifier and Type	Method and Description
Object	createNewVersion() Creates a new version of the object.
int	getVersionNum() Gets the version number of the object.
boolean	isCurrentVersion() Indicates that this object was the current version when it was returned by a query.

Method Detail

createNewVersion

Object createNewVersion()
                 throws HDRRimException

Creates a new version of the object.

All attributes are cloned to the new version and the version number is incremented by one. HDR checks the version number when the object is persisted and ensures that there have not been any other updates to the object since it was queried.

Returns:

The new version of the Object created. You can downcast this to the correct RIM class.

Throws:

HDRRimException - When the object on which createNewVersion() is called does not meet the following conditions:

• The object must have been queried. It is not valid to call createNewVersion() after creating the object using a factory. Similarly, calling createNewVersion() on an object twice will fail.
• The object must be the current version. Calling isCurrentVersion() on the object must return true.
• The object must not be a control act with class code "CACT".

isCurrentVersion

boolean isCurrentVersion()

Indicates that this object was the current version when it was returned by a query. This method does not requery the data after the object is created. Therefore the return value of this method does not guarantee that subsequent versions of the object have not been created.

Returns:

true if this object was the current version when it was returned by a query, else false.

getVersionNum

int getVersionNum()

Gets the version number of the object. Version numbers are sequential, starting at 1, incremented by 1.

Returns:

The version number.