wt.workflow.engine
Class WfEventAudit

java.lang.Object
  wt.fc.WTObject
      wt.enterprise.Simple
          wt.workflow.engine.WfEventAudit

All Implemented Interfaces:

AccessControlled, BusinessInformation, DisplayIdentification, DomainAdministered, Externalizable, NetFactor, Notifiable, ObjectMappable, Persistable, Serializable

Direct Known Subclasses:

WfAssignmentEventAudit, WfCreateProcessEventAudit, WfDataEventAudit, WfExceptionEventAudit, WfStateEventAudit, WfVotingEventAudit

public abstract class WfEventAudit

extends Simple

implements Externalizable

The 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 events are not part of the persistent state of their source workflow object.

A workflow event audit object is created whe 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.

Note: It is possible to specify which events are actually recorded in a per template or per process basis. The default configuration of which events are recorded is defined in the wt.properties file.

Supported API: false

Extendable: false

See Also:

Serialized Form

Field Summary

static String	ACTIVITY_KEY Label for the attribute; Identifies the WfActivity associated with the event; null for process events.
static String	ACTIVITY_NAME Label for the attribute; Name of the WfActivity associated with the event; null for process events.
private static int	ACTIVITY_NAME_UPPER_LIMIT
private long	activityKey
private String	activityName
private static String	CLASSNAME
static String	EVENT_TYPE Label for the attribute; Describes the audit event type.
private static int	EVENT_TYPE_UPPER_LIMIT
private WfEventAuditType	eventType
static long	EXTERNALIZATION_VERSION_UID
protected static long	OLD_FORMAT_VERSION_UID
static String	PROCESS_KEY Label for the attribute; Identifies the WfProcess associated with the event.
static String	PROCESS_NAME Label for the attribute; Name of the process associated with the event.
private static int	PROCESS_NAME_UPPER_LIMIT
static String	PROCESS_TEMPLATE_NAME Label for the attribute; Name of the process template associated with the event.
private static int	PROCESS_TEMPLATE_NAME_UPPER_LIMIT
static String	PROCESS_TEMPLATE_VERSION Label for the attribute; Version of the process template.
private static int	PROCESS_TEMPLATE_VERSION_UPPER_LIMIT
private long	processKey
private String	processName
private String	processTemplateName
private String	processTemplateVersion
private static String	RESOURCE
(package private) static long	serialVersionUID
private Timestamp	timestamp
static String	TIMESTAMP Label for the attribute; Records time of the event.
static String	TRIP_COUNT Label for the attribute.
private int	tripCount
static String	USER_REF Label for the attribute.
private WTPrincipalReference	userRef

Fields inherited from class wt.enterprise.Simple

Fields inherited from class wt.fc.WTObject

CREATE_TIMESTAMP, MODIFY_TIMESTAMP

Fields inherited from interface wt.admin.DomainAdministered

DOMAIN_REF, INHERITED_DOMAIN

Fields inherited from interface wt.fc.BusinessInformation

BUSINESS_TYPE, IDENTITY

Fields inherited from interface wt.notify.Notifiable

EVENT_SET

Fields inherited from interface wt.fc.Persistable

IDENTITY, PERSIST_INFO, TYPE

Fields inherited from interface wt.identity.DisplayIdentification

DISPLAY_IDENTIFIER, DISPLAY_IDENTITY, DISPLAY_TYPE

Constructor Summary

WfEventAudit()

Method Summary

boolean	equals(Object obj) Indicates whether the given object is equal to this object from a persistence perspective, by comparing the two objects ObjectIdentifiers.
long	getActivityKey() Gets the value of the attribute: ACTIVITY_KEY.
String	getActivityName() Gets the value of the attribute: ACTIVITY_NAME.
WfEventAuditType	getEventType() Gets the value of the attribute: EVENT_TYPE.
long	getProcessKey() Gets the value of the attribute: PROCESS_KEY.
String	getProcessName() Gets the value of the attribute: PROCESS_NAME.
String	getProcessTemplateName() Gets the value of the attribute: PROCESS_TEMPLATE_NAME.
String	getProcessTemplateVersion() Gets the value of the attribute: PROCESS_TEMPLATE_VERSION.
WfExecutionObject	getSource() Returns the execution object that was the source of the event.
Timestamp	getTimestamp() Gets the value of the attribute: TIMESTAMP.
int	getTripCount() Gets the value of the attribute: TRIP_COUNT.
WTPrincipalReference	getUserRef() Gets the value of the attribute: USER_REF.
int	hashCode() Returns a hash code for this object based upon its ObjectIdentifier.
protected void	initialize(WTContainerRef container_ref) Supported API: false
void	readExternal(ObjectInput input) Reads the non-transient fields of this class from an external source.
void	readExternal(PersistentRetrieveIfc input) Used by Persistent Data Service to populate the persistent attributes of this class from a persistent store.
private boolean	readOldVersion(ObjectInput input, long readSerialVersionUID, boolean passThrough, boolean superDone) Reads the non-transient fields of this class from an external source, which is not the current version.
protected boolean	readVersion(WfEventAudit thisObject, ObjectInput input, long readSerialVersionUID, boolean passThrough, boolean superDone) Reads the non-transient fields of this class from an external source.
void	setActivityKey(long a_ActivityKey) Sets the value of the attribute: ACTIVITY_KEY.
void	setActivityName(String a_ActivityName) Sets the value of the attribute: ACTIVITY_NAME.
void	setEventType(WfEventAuditType a_EventType) Sets the value of the attribute: EVENT_TYPE.
void	setProcessKey(long a_ProcessKey) Sets the value of the attribute: PROCESS_KEY.
void	setProcessName(String a_ProcessName) Sets the value of the attribute: PROCESS_NAME.
void	setProcessTemplateName(String a_ProcessTemplateName) Sets the value of the attribute: PROCESS_TEMPLATE_NAME.
void	setProcessTemplateVersion(String a_ProcessTemplateVersion) Sets the value of the attribute: PROCESS_TEMPLATE_VERSION.
void	setTimestamp(Timestamp a_Timestamp) Sets the value of the attribute: TIMESTAMP.
void	setTripCount(int a_TripCount) Sets the value of the attribute: TRIP_COUNT.
void	setUserRef(WTPrincipalReference a_UserRef) Sets the value of the attribute: USER_REF.
String	toString() Returns a string representation of the connector object.
void	writeExternal(ObjectOutput output) Writes the non-transient fields of this class to an external source.
void	writeExternal(PersistentStoreIfc output) Used by Persistent Data Service to obtain the values of the persistent attributes of this class, so they can be written to a persistent store.

Methods inherited from class wt.enterprise.Simple

getBusinessType, getDomainRef, getEventSet, getIdentity, initialize, isInheritedDomain, readVersion, setDomainRef, setEventSet, setInheritedDomain

Methods inherited from class wt.fc.WTObject

checkAttributes, duplicate, finalize, getClassInfo, getCreateTimestamp, getDisplayIdentifier, getDisplayIdentity, getDisplayType, getModifyTimestamp, getPersistInfo, getType, readVersion, setPersistInfo

Methods inherited from class java.lang.Object

clone, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface wt.fc.NetFactor

getClassInfo, getConceptualClassname

Field Detail

RESOURCE

private static final String RESOURCE

See Also:

Constant Field Values

CLASSNAME

private static final String CLASSNAME

TIMESTAMP

public static final String TIMESTAMP

Label for the attribute; Records time of the event.

Supported API: false

See Also:

Constant Field Values

timestamp

private Timestamp timestamp

EVENT_TYPE

public static final String EVENT_TYPE

Label for the attribute; Describes the audit event type.

Supported API: false

See Also:

Constant Field Values

EVENT_TYPE_UPPER_LIMIT

private static int EVENT_TYPE_UPPER_LIMIT

eventType

private WfEventAuditType eventType

ACTIVITY_KEY

public static final String ACTIVITY_KEY

Label for the attribute; Identifies the WfActivity associated with the event; null for process events.

Supported API: false

See Also:

Constant Field Values

activityKey

private long activityKey

ACTIVITY_NAME

public static final String ACTIVITY_NAME

Label for the attribute; Name of the WfActivity associated with the event; null for process events.

Supported API: false

See Also:

Constant Field Values

ACTIVITY_NAME_UPPER_LIMIT

private static int ACTIVITY_NAME_UPPER_LIMIT

activityName

private String activityName

PROCESS_KEY

public static final String PROCESS_KEY

Label for the attribute; Identifies the WfProcess associated with the event.

Supported API: false

See Also:

Constant Field Values

processKey

private long processKey

PROCESS_NAME

public static final String PROCESS_NAME

Label for the attribute; Name of the process associated with the event.

Supported API: false

See Also:

Constant Field Values

PROCESS_NAME_UPPER_LIMIT

private static int PROCESS_NAME_UPPER_LIMIT

processName

private String processName

PROCESS_TEMPLATE_NAME

public static final String PROCESS_TEMPLATE_NAME

Label for the attribute; Name of the process template associated with the event.

Supported API: false

See Also:

Constant Field Values

PROCESS_TEMPLATE_NAME_UPPER_LIMIT

private static int PROCESS_TEMPLATE_NAME_UPPER_LIMIT

processTemplateName

private String processTemplateName

PROCESS_TEMPLATE_VERSION

public static final String PROCESS_TEMPLATE_VERSION

Label for the attribute; Version of the process template.

Supported API: false

See Also:

Constant Field Values

PROCESS_TEMPLATE_VERSION_UPPER_LIMIT

private static int PROCESS_TEMPLATE_VERSION_UPPER_LIMIT

processTemplateVersion

private String processTemplateVersion

USER_REF

public static final String USER_REF

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

userRef

private WTPrincipalReference userRef

TRIP_COUNT

public static final String TRIP_COUNT

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

tripCount

private int tripCount

serialVersionUID

static final long serialVersionUID

See Also:

Constant Field Values

EXTERNALIZATION_VERSION_UID

public static final long EXTERNALIZATION_VERSION_UID

See Also:

Constant Field Values

OLD_FORMAT_VERSION_UID

protected static final long OLD_FORMAT_VERSION_UID

See Also:

Constant Field Values

Constructor Detail

WfEventAudit

public WfEventAudit()

Method Detail

writeExternal

public void writeExternal(ObjectOutput output)
                   throws IOException

Writes the non-transient fields of this class to an external source.

Supported API: false

Specified by:

writeExternal in interface Externalizable

Overrides:

writeExternal in class Simple

Parameters:

output -

Throws:

IOException

readExternal

public void readExternal(ObjectInput input)
                  throws IOException,
                         ClassNotFoundException

Reads the non-transient fields of this class from an external source.

Supported API: false

Specified by:

readExternal in interface Externalizable

Overrides:

readExternal in class Simple

Parameters:

input -

Throws:

IOException

ClassNotFoundException

readVersion

protected boolean readVersion(WfEventAudit thisObject,
                              ObjectInput input,
                              long readSerialVersionUID,
                              boolean passThrough,
                              boolean superDone)
                       throws IOException,
                              ClassNotFoundException

Reads the non-transient fields of this class from an external source.

Supported API: false

Parameters:

thisObject -

input -

readSerialVersionUID -

passThrough -

superDone -

Returns:

boolean

Throws:

IOException

ClassNotFoundException

readOldVersion

private boolean readOldVersion(ObjectInput input,
                               long readSerialVersionUID,
                               boolean passThrough,
                               boolean superDone)
                        throws IOException,
                               ClassNotFoundException

Reads the non-transient fields of this class from an external source, which is not the current version.

Parameters:

input -

readSerialVersionUID -

passThrough -

superDone -

Returns:

boolean

Throws:

IOException

ClassNotFoundException

writeExternal

public void writeExternal(PersistentStoreIfc output)
                   throws SQLException,
                          DatastoreException

Used by Persistent Data Service to obtain the values of the persistent attributes of this class, so they can be written to a persistent store.

(Not intended for general use.)

Supported API: false

Specified by:

writeExternal in interface ObjectMappable

Overrides:

writeExternal in class Simple

Parameters:

output -

Throws:

SQLException

DatastoreException

readExternal

public void readExternal(PersistentRetrieveIfc input)
                  throws SQLException,
                         DatastoreException

Used by Persistent Data Service to populate the persistent attributes of this class from a persistent store.

(Not intended for general use.)

Supported API: false

Specified by:

readExternal in interface ObjectMappable

Overrides:

readExternal in class Simple

Parameters:

input -

Throws:

SQLException

DatastoreException

getTimestamp

public Timestamp getTimestamp()

Gets the value of the attribute: TIMESTAMP. Records time of the event.

Supported API: false

Returns:

Timestamp

setTimestamp

public void setTimestamp(Timestamp a_Timestamp)

Sets the value of the attribute: TIMESTAMP. Records time of the event.

Supported API: false

Parameters:

a_Timestamp -

getEventType

public WfEventAuditType getEventType()

Gets the value of the attribute: EVENT_TYPE. Describes the audit event type.

Supported API: false

Returns:

WfEventAuditType

setEventType

public void setEventType(WfEventAuditType a_EventType)

Sets the value of the attribute: EVENT_TYPE. Describes the audit event type.

Supported API: false

Parameters:

a_EventType -

getActivityKey

public long getActivityKey()

Gets the value of the attribute: ACTIVITY_KEY. Identifies the WfActivity associated with the event; null for process events.

Supported API: false

Returns:

long

setActivityKey

public void setActivityKey(long a_ActivityKey)

Sets the value of the attribute: ACTIVITY_KEY. Identifies the WfActivity associated with the event; null for process events.

Supported API: false

Parameters:

a_ActivityKey -

getActivityName

public String getActivityName()

Gets the value of the attribute: ACTIVITY_NAME. Name of the WfActivity associated with the event; null for process events.

Supported API: false

Returns:

String

setActivityName

public void setActivityName(String a_ActivityName)

Sets the value of the attribute: ACTIVITY_NAME. Name of the WfActivity associated with the event; null for process events.

Supported API: false

Parameters:

a_ActivityName -

getProcessKey

public long getProcessKey()

Gets the value of the attribute: PROCESS_KEY. Identifies the WfProcess associated with the event.

Supported API: false

Returns:

long

setProcessKey

public void setProcessKey(long a_ProcessKey)

Sets the value of the attribute: PROCESS_KEY. Identifies the WfProcess associated with the event.

Supported API: false

Parameters:

a_ProcessKey -

getProcessName

public String getProcessName()

Gets the value of the attribute: PROCESS_NAME. Name of the process associated with the event.

Supported API: false

Returns:

String

setProcessName

public void setProcessName(String a_ProcessName)

Sets the value of the attribute: PROCESS_NAME. Name of the process associated with the event.

Supported API: false

Parameters:

a_ProcessName -

getProcessTemplateName

public String getProcessTemplateName()

Gets the value of the attribute: PROCESS_TEMPLATE_NAME. Name of the process template associated with the event.

Supported API: false

Returns:

String

setProcessTemplateName

public void setProcessTemplateName(String a_ProcessTemplateName)

Sets the value of the attribute: PROCESS_TEMPLATE_NAME. Name of the process template associated with the event.

Supported API: false

Parameters:

a_ProcessTemplateName -

getProcessTemplateVersion

public String getProcessTemplateVersion()

Gets the value of the attribute: PROCESS_TEMPLATE_VERSION. Version of the process template.

Supported API: false

Returns:

String

setProcessTemplateVersion

public void setProcessTemplateVersion(String a_ProcessTemplateVersion)

Sets the value of the attribute: PROCESS_TEMPLATE_VERSION. Version of the process template.

Supported API: false

Parameters:

a_ProcessTemplateVersion -

getUserRef

public WTPrincipalReference getUserRef()

Gets the value of the attribute: USER_REF.

Supported API: false

Returns:

WTPrincipalReference

setUserRef

public void setUserRef(WTPrincipalReference a_UserRef)

Sets the value of the attribute: USER_REF.

Supported API: false

Parameters:

a_UserRef -

getTripCount

public int getTripCount()

Gets the value of the attribute: TRIP_COUNT.

Supported API: false

Returns:

int

setTripCount

public void setTripCount(int a_TripCount)

Sets the value of the attribute: TRIP_COUNT.

Supported API: false

Parameters:

a_TripCount -

getSource

public WfExecutionObject getSource()
                            throws WTException

Returns the execution object that was the source of the event. Throws "SourceNotAvailableException" if the object has been deleted.

Supported API: false

Returns:

WfExecutionObject

Throws:

WTException

toString

public String toString()

Returns a string representation of the connector object. Used mostly for debugging purposes: not appropriate for GUI use.

Supported API: false

Overrides:

toString in class WTObject

Returns:

String

initialize

protected void initialize(WTContainerRef container_ref)
                   throws WTException

Supported API: false

Parameters:

container_ref -

Throws:

WTException

equals

public boolean equals(Object obj)

Indicates whether the given object is equal to this object from a persistence perspective, by comparing the two objects ObjectIdentifiers. Changed or stale copies are still considered equal by this method. Delegates to PersistenceHelper.equals(Persistable,Object).

Warning: Certain core Windchill operations may depend upon equals being ObjectIdentifier-based. Changes to the default implementation should be done with care, if at all.

Supported API: false

Overrides:

equals in class Simple

Parameters:

obj -

Returns:

boolean

hashCode

public int hashCode()

Returns a hash code for this object based upon its ObjectIdentifier. Delegates to PersistenceHelper.hashCode(Persistable).

Warning: Certain core Windchill operations may depend upon hashCode being ObjectIdentifier-based. Changes to the default implementation should be done with care, if at all.

Supported API: false

Overrides:

hashCode in class Simple

Returns:

int