wt.workflow.engine
Class WfAssignmentEventAudit

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

All Implemented Interfaces:

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

public class WfAssignmentEventAudit

extends WfEventAudit

implements Externalizable

WfAssignmentEventAudit specializes WfEventAudit for assignment change events. The event records resource (principal) and assignment status before and after the change. The eventType is activityAssignmentChanged.

An assignment change event is signaled when assignments for an activity are created, when the status of an assignment is changed, or when an existing assignment is reassigned to another reosurce. The WfActivity associated with the assignemtn is reported as the source of the event.

Use the newWfAssignmentEventAudit static factory method(s), not the WfAssignmentEventAudit 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_ASSIGNEE_REF Label for the attribute.
private WTPrincipalReference	newAssigneeRef
static String	OLD_ASSIGNEE_REF Label for the attribute.
protected static long	OLD_FORMAT_VERSION_UID
private WTPrincipalReference	oldAssigneeRef
static String	REASSIGN_COMMENT Label for the attribute; Comment field for reassignment.
private static int	REASSIGN_COMMENT_UPPER_LIMIT
private String	reassignComment
private static String	RESOURCE
private Role	role
static String	ROLE Label for the attribute.
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

WfAssignmentEventAudit()

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.
WTPrincipalReference	getNewAssigneeRef() Gets the value of the attribute: NEW_ASSIGNEE_REF.
WTPrincipalReference	getOldAssigneeRef() Gets the value of the attribute: OLD_ASSIGNEE_REF.
String	getReassignComment() Gets the value of the attribute: REASSIGN_COMMENT.
Role	getRole() Gets the value of the attribute: ROLE.
int	hashCode() Returns a hash code for this object based upon its ObjectIdentifier.
static WfAssignmentEventAudit	newWfAssignmentEventAudit(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(WfAssignmentEventAudit thisObject, ObjectInput input, long readSerialVersionUID, boolean passThrough, boolean superDone) Reads the non-transient fields of this class from an external source.
private void	reassignCommentValidate(String a_ReassignComment)
void	setNewAssigneeRef(WTPrincipalReference a_NewAssigneeRef) Sets the value of the attribute: NEW_ASSIGNEE_REF.
void	setOldAssigneeRef(WTPrincipalReference a_OldAssigneeRef) Sets the value of the attribute: OLD_ASSIGNEE_REF.
void	setReassignComment(String a_ReassignComment) Sets the value of the attribute: REASSIGN_COMMENT.
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

ROLE

public static final String ROLE

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

ROLE_UPPER_LIMIT

private static int ROLE_UPPER_LIMIT

role

private Role role

OLD_ASSIGNEE_REF

public static final String OLD_ASSIGNEE_REF

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

oldAssigneeRef

private WTPrincipalReference oldAssigneeRef

NEW_ASSIGNEE_REF

public static final String NEW_ASSIGNEE_REF

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

newAssigneeRef

private WTPrincipalReference newAssigneeRef

REASSIGN_COMMENT

public static final String REASSIGN_COMMENT

Label for the attribute; Comment field for reassignment.

Supported API: false

See Also:

Constant Field Values

REASSIGN_COMMENT_UPPER_LIMIT

private static int REASSIGN_COMMENT_UPPER_LIMIT

reassignComment

private String reassignComment

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

WfAssignmentEventAudit

public WfAssignmentEventAudit()

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

getRole

public Role getRole()

Gets the value of the attribute: ROLE.

Supported API: false

Returns:

Role

setRole

public void setRole(Role a_Role)

Sets the value of the attribute: ROLE.

Supported API: false

Parameters:

a_Role -

getOldAssigneeRef

public WTPrincipalReference getOldAssigneeRef()

Gets the value of the attribute: OLD_ASSIGNEE_REF.

Supported API: false

Returns:

WTPrincipalReference

setOldAssigneeRef

public void setOldAssigneeRef(WTPrincipalReference a_OldAssigneeRef)

Sets the value of the attribute: OLD_ASSIGNEE_REF.

Supported API: false

Parameters:

a_OldAssigneeRef -

getNewAssigneeRef

public WTPrincipalReference getNewAssigneeRef()

Gets the value of the attribute: NEW_ASSIGNEE_REF.

Supported API: false

Returns:

WTPrincipalReference

setNewAssigneeRef

public void setNewAssigneeRef(WTPrincipalReference a_NewAssigneeRef)

Sets the value of the attribute: NEW_ASSIGNEE_REF.

Supported API: false

Parameters:

a_NewAssigneeRef -

getReassignComment

public String getReassignComment()

Gets the value of the attribute: REASSIGN_COMMENT. Comment field for reassignment.

Supported API: false

Returns:

String

setReassignComment

public void setReassignComment(String a_ReassignComment)
                        throws WTPropertyVetoException

Sets the value of the attribute: REASSIGN_COMMENT. Comment field for reassignment.

Supported API: false

Parameters:

a_ReassignComment -

Throws:

WTPropertyVetoException

reassignCommentValidate

private void reassignCommentValidate(String a_ReassignComment)
                              throws WTPropertyVetoException

Parameters:

a_ReassignComment -

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

newWfAssignmentEventAudit

public static WfAssignmentEventAudit newWfAssignmentEventAudit(WTContainerRef container_ref)
                                                        throws WTException

Supported API: false

Parameters:

container_ref -

Returns:

WfAssignmentEventAudit

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