oracle.hsgbu.hdr.hl7.rim

Interface InfrastructureRoot

All Superinterfaces:

Serializable

All Known Subinterfaces:

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

public interface InfrastructureRoot
extends Serializable

This abstract class is a super-type for all RIM classes, either directly or through inheritance. It provides a set of communication infrastructure attributes that may be used in instances of HL7-specified, RIM-based communications. When valued in a communication instance, these attributes indicate whether the information structure is being constrained by specifically defined templates, realms or common communication element types. In general, constraint declarations, such as those communicated in this class' attributes, may occur wherever a RIM class or one of its derived clones is instantiated in an HL7 communication. Thus the attributes must be available in all RIM classes and clones.

See Also:

factories, ANY

Summary

Method Summary

Modifier and Type	Method and Description
ControlAct	getControlAct() Given a specific version of any object, returns the ControlAct in which it was created.
String	getToken() Gets the token.
void	setToken(String token) Sets an arbitrary token on the RIM object.

Method Detail

getToken

String getToken()

Gets the token.

Returns:

The token set on the object by the user.

See Also:

setToken(String)

setToken

void setToken(String token)
       throws HDRRimException

Sets an arbitrary token on the RIM object.

The token is used for exception-handling to give more precise information about where in a submitted object graph an exception has occurred. If an exception can be attributed to a problem with one object, generally due to validation errors, the exception will contain the token set on the object.

This value is not validated, but it is expected to be unique across the objects in any given submission.

Parameters:

token - The token.

Throws:

HDRRimException

getControlAct

ControlAct getControlAct()
                  throws HDRRimException

Given a specific version of any object, returns the ControlAct in which it was created. The ControlAct provides information such as the reason the transaction occurred, who the author of the change is, etc.

Returns:

A ControlAct.

Throws:

HDRRimException