wt.workflow.engine
Class WfStateEventAudit

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

All Implemented Interfaces:

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

public class WfStateEventAudit

extends WfEventAudit

implements Externalizable

This class specializes WfEventAudit by adding state change information. A state change event is signaled when a WfExecutionObject changes its state; this covers both state changes resulting from a changeState operation request and internal state changes triggered by the execution logic of a WfProcess (e. g., process completes successfully, activity is suspended because the containing process was suspended, etc.). The eventType is PROCESS_STATE_CHANGED or ACTIVITY_STATE_CHANGED.

Use the newWfStateEventAudit static factory method(s), not the WfStateEventAudit constructor, to construct instances of this class. Instances must be constructed using the static factory(s), in order to ensure proper initialization of the instance.

Supported API: false

Extendable: false

See Also:

Serialized Form

Field Summary

private static String	CLASSNAME
static long	EXTERNALIZATION_VERSION_UID
static String	NEW_STATE Label for the attribute; The state of the execution object after the status change is recorded.
private static int	NEW_STATE_UPPER_LIMIT
private WfState	newState
protected static long	OLD_FORMAT_VERSION_UID
static String	OLD_STATE Label for the attribute; The state of the execution object before the status change is recorded.
private static int	OLD_STATE_UPPER_LIMIT
private WfState	oldState
private static String	RESOURCE
(package private) static long	serialVersionUID
static String	USER_EVENT_LIST Label for the attribute.
private static int	USER_EVENT_LIST_UPPER_LIMIT
private UserEventVector	userEventList

Fields inherited from class wt.workflow.engine.WfEventAudit

ACTIVITY_KEY, ACTIVITY_NAME, EVENT_TYPE, PROCESS_KEY, PROCESS_NAME, PROCESS_TEMPLATE_NAME, PROCESS_TEMPLATE_VERSION, TIMESTAMP, TRIP_COUNT, USER_REF

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

WfStateEventAudit()

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.
String	getConceptualClassname() Deprecated.
WfState	getNewState() Gets the value of the attribute: NEW_STATE.
WfState	getOldState() Gets the value of the attribute: OLD_STATE.
UserEventVector	getUserEventList() Gets the value of the attribute: USER_EVENT_LIST.
int	hashCode() Returns a hash code for this object based upon its ObjectIdentifier.
static WfStateEventAudit	newWfStateEventAudit(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(WfStateEventAudit thisObject, ObjectInput input, long readSerialVersionUID, boolean passThrough, boolean superDone) Reads the non-transient fields of this class from an external source.
void	setNewState(WfState a_NewState) Sets the value of the attribute: NEW_STATE.
void	setOldState(WfState a_OldState) Sets the value of the attribute: OLD_STATE.
void	setUserEventList(UserEventVector a_UserEventList) Sets the value of the attribute: USER_EVENT_LIST.
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.workflow.engine.WfEventAudit

getActivityKey, getActivityName, getEventType, getProcessKey, getProcessName, getProcessTemplateName, getProcessTemplateVersion, getSource, getTimestamp, getTripCount, getUserRef, initialize, readVersion, setActivityKey, setActivityName, setEventType, setProcessKey, setProcessName, setProcessTemplateName, setProcessTemplateVersion, setTimestamp, setTripCount, setUserRef

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

Field Detail

RESOURCE

private static final String RESOURCE

See Also:

Constant Field Values

CLASSNAME

private static final String CLASSNAME

OLD_STATE

public static final String OLD_STATE

Label for the attribute; The state of the execution object before the status change is recorded.

Supported API: false

See Also:

Constant Field Values

OLD_STATE_UPPER_LIMIT

private static int OLD_STATE_UPPER_LIMIT

oldState

private WfState oldState

NEW_STATE

public static final String NEW_STATE

Label for the attribute; The state of the execution object after the status change is recorded.

Supported API: false

See Also:

Constant Field Values

NEW_STATE_UPPER_LIMIT

private static int NEW_STATE_UPPER_LIMIT

newState

private WfState newState

USER_EVENT_LIST

public static final String USER_EVENT_LIST

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

USER_EVENT_LIST_UPPER_LIMIT

private static int USER_EVENT_LIST_UPPER_LIMIT

userEventList

private UserEventVector userEventList

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

WfStateEventAudit

public WfStateEventAudit()

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 WfEventAudit

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 WfEventAudit

Parameters:

input -

Throws:

IOException

ClassNotFoundException

readVersion

protected boolean readVersion(WfStateEventAudit 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 WfEventAudit

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 WfEventAudit

Parameters:

input -

Throws:

SQLException

DatastoreException

getConceptualClassname

public String getConceptualClassname()

Deprecated.

Returns the conceptual (modeled) name for the class.

Supported API: false

Specified by:

getConceptualClassname in interface NetFactor

Returns:

String

getOldState

public WfState getOldState()

Gets the value of the attribute: OLD_STATE. The state of the execution object before the status change is recorded.

Supported API: false

Returns:

WfState

setOldState

public void setOldState(WfState a_OldState)

Sets the value of the attribute: OLD_STATE. The state of the execution object before the status change is recorded.

Supported API: false

Parameters:

a_OldState -

getNewState

public WfState getNewState()

Gets the value of the attribute: NEW_STATE. The state of the execution object after the status change is recorded.

Supported API: false

Returns:

WfState

setNewState

public void setNewState(WfState a_NewState)

Sets the value of the attribute: NEW_STATE. The state of the execution object after the status change is recorded.

Supported API: false

Parameters:

a_NewState -

getUserEventList

public UserEventVector getUserEventList()

Gets the value of the attribute: USER_EVENT_LIST.

Supported API: false

Returns:

UserEventVector

setUserEventList

public void setUserEventList(UserEventVector a_UserEventList)

Sets the value of the attribute: USER_EVENT_LIST.

Supported API: false

Parameters:

a_UserEventList -

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 WfEventAudit

Returns:

String

newWfStateEventAudit

public static WfStateEventAudit newWfStateEventAudit(WTContainerRef container_ref)
                                              throws WTException

Supported API: false

Parameters:

container_ref -

Returns:

WfStateEventAudit

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 WfEventAudit

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 WfEventAudit

Returns:

int