wt.workflow.engine
Class WfDataEventAudit

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

All Implemented Interfaces:

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

public class WfDataEventAudit

extends WfEventAudit

implements Externalizable

WfDataEventAudit specializes WfEventAudit for data change events. A data change event is signaled when the the context of an execution object is updated. The eventType is PROCESS_CONTEXT_CHANGED, PROCESS_RESULT_CHANGED, ACTIVITY_CONTEXT_CHANGED or ACTIVITY_RESULT_CHANGED. To be compatible with WfMC terminology, CONTEXT_CHANGED types are associated with reading or values and RESULT_CHANGED types are associated with writing of values.

Use the newWfDataEventAudit static factory method(s), not the WfDataEventAudit 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
private String	instructions
static String	INSTRUCTIONS Label for the attribute; Activity instructions for the data change.
private static int	INSTRUCTIONS_UPPER_LIMIT
static String	NEW_DATA Label for the attribute; Identifies the new data to be used.
private ProcessData	newData
static String	OLD_DATA Label for the attribute; Identifies the previous data used.
protected static long	OLD_FORMAT_VERSION_UID
private ProcessData	oldData
private static String	RESOURCE
private Role	role
static String	ROLE Label for the attribute; Assignee role for the activity data changes.
private static int	ROLE_UPPER_LIMIT
(package private) static long	serialVersionUID

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

WfDataEventAudit()

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.
String	getInstructions() Gets the value of the attribute: INSTRUCTIONS.
ProcessData	getNewData() Gets the value of the attribute: NEW_DATA.
ProcessData	getOldData() Gets the value of the attribute: OLD_DATA.
Role	getRole() Gets the value of the attribute: ROLE.
int	hashCode() Returns a hash code for this object based upon its ObjectIdentifier.
private void	instructionsValidate(String a_Instructions)
static WfDataEventAudit	newWfDataEventAudit(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(WfDataEventAudit thisObject, ObjectInput input, long readSerialVersionUID, boolean passThrough, boolean superDone) Reads the non-transient fields of this class from an external source.
void	setInstructions(String a_Instructions) Sets the value of the attribute: INSTRUCTIONS.
void	setNewData(ProcessData a_NewData) Sets the value of the attribute: NEW_DATA.
void	setOldData(ProcessData a_OldData) Sets the value of the attribute: OLD_DATA.
void	setRole(Role a_Role) Sets the value of the attribute: ROLE.
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_DATA

public static final String OLD_DATA

Label for the attribute; Identifies the previous data used. Only the data item that were updated are reported. This event also records the initialization of the execution object's context.

Supported API: false

See Also:

Constant Field Values

oldData

private ProcessData oldData

NEW_DATA

public static final String NEW_DATA

Label for the attribute; Identifies the new data to be used.

Supported API: false

See Also:

Constant Field Values

newData

private ProcessData newData

ROLE

public static final String ROLE

Label for the attribute; Assignee role for the activity data changes.

Supported API: false

See Also:

Constant Field Values

ROLE_UPPER_LIMIT

private static int ROLE_UPPER_LIMIT

role

private Role role

INSTRUCTIONS

public static final String INSTRUCTIONS

Label for the attribute; Activity instructions for the data change.

Supported API: false

See Also:

Constant Field Values

INSTRUCTIONS_UPPER_LIMIT

private static int INSTRUCTIONS_UPPER_LIMIT

instructions

private String instructions

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

WfDataEventAudit

public WfDataEventAudit()

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(WfDataEventAudit 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

getOldData

public ProcessData getOldData()

Gets the value of the attribute: OLD_DATA. Identifies the previous data used. Only the data item that were updated are reported. This event also records the initialization of the execution object's context.

Supported API: false

Returns:

ProcessData

setOldData

public void setOldData(ProcessData a_OldData)

Sets the value of the attribute: OLD_DATA. Identifies the previous data used. Only the data item that were updated are reported. This event also records the initialization of the execution object's context.

Supported API: false

Parameters:

a_OldData -

getNewData

public ProcessData getNewData()

Gets the value of the attribute: NEW_DATA. Identifies the new data to be used.

Supported API: false

Returns:

ProcessData

setNewData

public void setNewData(ProcessData a_NewData)

Sets the value of the attribute: NEW_DATA. Identifies the new data to be used.

Supported API: false

Parameters:

a_NewData -

getRole

public Role getRole()

Gets the value of the attribute: ROLE. Assignee role for the activity data changes.

Supported API: false

Returns:

Role

setRole

public void setRole(Role a_Role)

Sets the value of the attribute: ROLE. Assignee role for the activity data changes.

Supported API: false

Parameters:

a_Role -

getInstructions

public String getInstructions()

Gets the value of the attribute: INSTRUCTIONS. Activity instructions for the data change.

Supported API: false

Returns:

String

setInstructions

public void setInstructions(String a_Instructions)
                     throws WTPropertyVetoException

Sets the value of the attribute: INSTRUCTIONS. Activity instructions for the data change.

Supported API: false

Parameters:

a_Instructions -

Throws:

WTPropertyVetoException

instructionsValidate

private void instructionsValidate(String a_Instructions)
                           throws WTPropertyVetoException

Parameters:

a_Instructions -

Throws:

WTPropertyVetoException

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

newWfDataEventAudit

public static WfDataEventAudit newWfDataEventAudit(WTContainerRef container_ref)
                                            throws WTException

Supported API: false

Parameters:

container_ref -

Returns:

WfDataEventAudit

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