public interface ControlAct extends Act
An act representing a change to the state of another class, a user event (example, query), or a system event (example, time-based occurrences).
Examples:
SubstanceAdministration
from active
to aborted); Discussion: This class corresponds to the concept of 'Trigger Event', and as such, must be present as the focus of every messaging interaction (because of the 1..1 association between a trigger event and an interaction.) However, control acts can also appear within a message payload. For example, a set of control acts associated with a lab order identifying the events that have occurred against that order (first created, then revised, then suspended, then resumed, then completed.)
Oracle: control acts are the primary mechanism through which RIM data is persisted and queried through HDR.
To persist data to HDR a control act must have exactly one outbound
ActRelationship
of type SUBJ. The target of this act
relationship is expected to be an Act
or a subclass of
Act
. The target act can have other act relationships or include
participations to roles and thereby be associated with Entities.
It is possible to retrieve the ControlAct
through which an
Act
, Role
or Entity
is submitted.
A control act can also have participations and act relationships of its own
as with any Act
. Any attributes of the control act itself will
also be persisted.
The code attribute of a control act contains the trigger event. If the trigger event is omitted, state transitions of the focal class may still be performed. See Master Catalog for a complete description of how this is specified.
The submitted (top-level) control act must be in EVN mood and its status is "active". Once persisted, a top-level control act can never be updated. Thus, its highest version number will always be 1.
Non-top-level control acts, those "underneath" the top-level control act behave like regular acts. That is, they are not constrained to a single version and they can be created and referenced as with any other acts. However, a top-level act that is referenced still cannot be updated or versioned.
Act
,
Role
,
Entity
,
Participation
,
ActRelationship
Modifier and Type | Method and Description |
---|---|
ControlActCategoryCode |
getCategoryCode()
Gets the ControlAct Category Enum value
|
void |
setCategoryCode(ControlActCategoryCode cactCategoryEnum)
Sets the ControlAct Category Enum value
|
addConfidentialityCode, addIBActRelationship, addId, addOBActRelationship, addParticipation, addPriorityCode, addReasonCode, getActivityTime, getAvailabilityTime, getClassCode, getCode, getConfidentialityCode, getDerivationExpr, getEffectiveTime, getIBActRelationships, getIBActRelationships, getId, getIndependentInd, getInterruptibleInd, getLanguageCode, getLevelCode, getMoodCode, getNegationInd, getOBActRelationships, getOBActRelationships, getParticipations, getParticipations, getPriorityCode, getReasonCode, getRepeatNumber, getStatusCode, getText, getTitle, getUncertaintyCode, setActivityTime, setAvailabilityTime, setConfidentialityCode, setDerivationExpr, setEffectiveTime, setIndependentInd, setInterruptibleInd, setLanguageCode, setLevelCode, setNegationInd, setPriorityCode, setReasonCode, setRepeatNumber, setStatusCode, setText, setTitle, setUncertaintyCode
getControlAct, getToken, setToken
createNewVersion, getVersionNum, isCurrentVersion
ControlActCategoryCode getCategoryCode()
void setCategoryCode(ControlActCategoryCode cactCategoryEnum) throws HDRRimException
cactCategoryEnum
- the ControlAct Category Enum value to setHDRRimException
HDR Glossary HDR Concept Lists HDR Exceptions HDR Programmer's Guide HDR Implementation Guide HDR Profile Options
Copyright © 2016, 2018, Oracle. All rights reserved