org.enhydra.shark.api.client.wfmodel
Interface WfEventAudit

All Superinterfaces:
BaseBusinessObject, java.io.Serializable
All Known Subinterfaces:
WfAssignmentEventAudit, WfAssignmentEventAuditInternal, WfCreateProcessEventAudit, WfCreateProcessEventAuditInternal, WfDataEventAudit, WfDataEventAuditInternal, WfEventAuditInternal, WfPackageEventAudit, WfStateEventAudit, WfStateEventAuditInternal

public interface WfEventAudit
extends BaseBusinessObject

OMG definition: WfEventAudit provides audit records of workflow event information. It provides information on the source of the event and contains specific event data. Workflow events include state changes, change of a resource assignment, and data changes. Workflow events are persistent and can be accessed navigating the history relationship of a WfExecutionObject. Workflow audit event objects are not part of the persistent state of their source workflow object.

A workflow event audit object is created when a workflow object changes its status (state change, process data change or assignment change); its lifetime is not limited by the lifetime of the event source object. Operations for managing the retention, archiving, and deletion of workflow events are not specified in this specification. The WfEventAudit defines a set of event properties common to all workflow audit events. In particular, it provides an identification of the source of the event in terms of (business) identifiers of the workflow entities WfProcessMgr, WfProcess, and WfActivity.

We extended OMG's interface by duplicating method source, and adding additional parameter that represents transaction. If you use method without SharkTransaction parameter, the transaction will be implicitly created, and if you use it with SharkTransaction parameter you must obey to some rules explained in HowTo documentation.


Method Summary
 java.lang.String activity_key()
          If the event is triggered by a status change of a WfActivity, the key and the name of the activity is recorded with the WfEventAudit.
 java.lang.String activity_name()
          If the event is triggered by a status change of a WfActivity, the key and the name of the activity is recorded with the WfEventAudit.
 java.lang.String event_type()
          Identifies the specific event type.
 java.lang.String process_key()
          The key and the name of the WfProcess associated with the source of an event are recorded with the WfEventAudit.
 java.lang.String process_mgr_name()
          The WfProcessMgr associated with the workflow object that triggered the event is identified via its name and version.
 java.lang.String process_mgr_version()
          The WfProcessMgr associated with the workflow object that triggered the event is identified via its name and version.
 java.lang.String process_name()
          The key and the name of the WfProcess associated with the source of an event are recorded with the WfEventAudit.
 WfExecutionObject source()
          A WfEventAudit can be associated with the WfExecutionObject that triggered the event.
 UtcT time_stamp()
          Records the time the status change of the source occurred that triggered the event audit item to be created, using the TimeBase::UtcT data type defined by the OMG Time Service.
 

Method Detail

source

public WfExecutionObject source()
                         throws java.lang.Exception,
                                SourceNotAvailable
A WfEventAudit can be associated with the WfExecutionObject that triggered the event. Event audit items are meant to provide information on the execution history of workflow object even after the source object has been deleted; in this case, no source would be associated with the WfEventAudit.

The following operation returns the source of the event, when available; if the source is not available, a SourceNotAvailable exception is raised.

Throws:
java.lang.Exception
SourceNotAvailable

time_stamp

public UtcT time_stamp()
                throws java.lang.Exception
Records the time the status change of the source occurred that triggered the event audit item to be created, using the TimeBase::UtcT data type defined by the OMG Time Service.

Throws:
java.lang.Exception

event_type

public java.lang.String event_type()
                            throws java.lang.Exception
Identifies the specific event type. The following is a set of pre-defined event types; implementations of the WfM Facility may decide to support additional audit event types.

Throws:
java.lang.Exception

activity_key

public java.lang.String activity_key()
                              throws java.lang.Exception
If the event is triggered by a status change of a WfActivity, the key and the name of the activity is recorded with the WfEventAudit. Otherwise, the activity related attributes contain a NULL value.

The following operation returns the key of the WfActivity associated with the event.

Throws:
java.lang.Exception

activity_name

public java.lang.String activity_name()
                               throws java.lang.Exception
If the event is triggered by a status change of a WfActivity, the key and the name of the activity is recorded with the WfEventAudit. Otherwise, the activity related attributes contain a NULL value.

The following operation return the name of the WfActivity associated with the event.

Throws:
java.lang.Exception

process_key

public java.lang.String process_key()
                             throws java.lang.Exception
The key and the name of the WfProcess associated with the source of an event are recorded with the WfEventAudit. If the event was triggered by a WfActivity, this is the containing WfProcess. If it was triggered by a status change of a WfProcess, it is that process.

The following operation returns the key of the WfProcess associated with the event.

Throws:
java.lang.Exception

process_name

public java.lang.String process_name()
                              throws java.lang.Exception
The key and the name of the WfProcess associated with the source of an event are recorded with the WfEventAudit. If the event was triggered by a WfActivity, this is the containing WfProcess. If it was triggered by a status change of a WfProcess, it is that process.

The following operation returns the name of the WfProcess associated with the event.

Throws:
java.lang.Exception

process_mgr_name

public java.lang.String process_mgr_name()
                                  throws java.lang.Exception
The WfProcessMgr associated with the workflow object that triggered the event is identified via its name and version. If the event was triggered by a status change of an activity, this is the manager of the process that contains the activity. If it was triggered by a status change of a process, this is the manager of that process.

The following operation returns the name of the WfProcessMgr associated with the event.

Throws:
java.lang.Exception

process_mgr_version

public java.lang.String process_mgr_version()
                                     throws java.lang.Exception
The WfProcessMgr associated with the workflow object that triggered the event is identified via its name and version. If the event was triggered by a status change of an activity, this is the manager of the process that contains the activity. If it was triggered by a status change of a process, this is the manager of that process.

The following operation returns the version of the WfProcessMgr associated with the event.

Throws:
java.lang.Exception