wt.workflow.engine
Class WfCreateProcessEventAudit

java.lang.Object
  extended bywt.fc.WTObject
      extended bywt.enterprise.Simple
          extended bywt.workflow.engine.WfEventAudit
              extended bywt.workflow.engine.WfCreateProcessEventAudit
All Implemented Interfaces:
AccessControlled, BusinessInformation, DisplayIdentification, DomainAdministered, Externalizable, NetFactor, Notifiable, ObjectMappable, Persistable, Serializable

public class WfCreateProcessEventAudit
extends WfEventAudit
implements Externalizable

WfCreateProcessEventAudit specializes WfEventAudit by adding information related to creation of a WfProcess. The eventType is set to PROCESS_CREATED for this event.

Use the newWfCreateProcessEventAudit static factory method(s), not the WfCreateProcessEventAudit 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
static String APPLICATION_ID
          Label for the attribute; Identity of the application that is instantiating the process.
private static int APPLICATION_ID_UPPER_LIMIT
           
private  String applicationId
           
private static String CLASSNAME
           
static long EXTERNALIZATION_VERSION_UID
           
protected static long OLD_FORMAT_VERSION_UID
           
static String P_ACTIVITY_KEY
          Label for the attribute; Identifies activity which is the requester for the newly created process.
static String P_PROCESS_KEY
          Label for the attribute; Identifies process that contains parent activity.
static String P_PROCESS_TEMPLATE_NAME
          Label for the attribute; Identifies process template of the parent process.
private static int P_PROCESS_TEMPLATE_NAME_UPPER_LIMIT
           
static String P_PROCESS_TEMPLATE_VERSION
          Label for the attribute; Identifies the version of the process template of the parent process.
private static int P_PROCESS_TEMPLATE_VERSION_UPPER_LIMIT
           
private  long pActivityKey
           
private  long pProcessKey
           
private  String pProcessTemplateName
           
private  String pProcessTemplateVersion
           
private static String RESOURCE
           
(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
WfCreateProcessEventAudit()
           
 
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 getApplicationId()
          Gets the value of the attribute: APPLICATION_ID.
 String getConceptualClassname()
          Deprecated.  
 long getPActivityKey()
          Gets the value of the attribute: P_ACTIVITY_KEY.
 long getPProcessKey()
          Gets the value of the attribute: P_PROCESS_KEY.
 String getPProcessTemplateName()
          Gets the value of the attribute: P_PROCESS_TEMPLATE_NAME.
 String getPProcessTemplateVersion()
          Gets the value of the attribute: P_PROCESS_TEMPLATE_VERSION.
 int hashCode()
          Returns a hash code for this object based upon its ObjectIdentifier.
static WfCreateProcessEventAudit newWfCreateProcessEventAudit(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(WfCreateProcessEventAudit thisObject, ObjectInput input, long readSerialVersionUID, boolean passThrough, boolean superDone)
          Reads the non-transient fields of this class from an external source.
 void setApplicationId(String a_ApplicationId)
          Sets the value of the attribute: APPLICATION_ID.
 void setPActivityKey(long a_PActivityKey)
          Sets the value of the attribute: P_ACTIVITY_KEY.
 void setPProcessKey(long a_PProcessKey)
          Sets the value of the attribute: P_PROCESS_KEY.
 void setPProcessTemplateName(String a_PProcessTemplateName)
          Sets the value of the attribute: P_PROCESS_TEMPLATE_NAME.
 void setPProcessTemplateVersion(String a_PProcessTemplateVersion)
          Sets the value of the attribute: P_PROCESS_TEMPLATE_VERSION.
 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

P_ACTIVITY_KEY

public static final String P_ACTIVITY_KEY
Label for the attribute; Identifies activity which is the requester for the newly created process.

Supported API: false

See Also:
Constant Field Values

pActivityKey

private long pActivityKey

P_PROCESS_KEY

public static final String P_PROCESS_KEY
Label for the attribute; Identifies process that contains parent activity.

Supported API: false

See Also:
Constant Field Values

pProcessKey

private long pProcessKey

P_PROCESS_TEMPLATE_NAME

public static final String P_PROCESS_TEMPLATE_NAME
Label for the attribute; Identifies process template of the parent process.

Supported API: false

See Also:
Constant Field Values

P_PROCESS_TEMPLATE_NAME_UPPER_LIMIT

private static int P_PROCESS_TEMPLATE_NAME_UPPER_LIMIT

pProcessTemplateName

private String pProcessTemplateName

P_PROCESS_TEMPLATE_VERSION

public static final String P_PROCESS_TEMPLATE_VERSION
Label for the attribute; Identifies the version of the process template of the parent process.

Supported API: false

See Also:
Constant Field Values

P_PROCESS_TEMPLATE_VERSION_UPPER_LIMIT

private static int P_PROCESS_TEMPLATE_VERSION_UPPER_LIMIT

pProcessTemplateVersion

private String pProcessTemplateVersion

APPLICATION_ID

public static final String APPLICATION_ID
Label for the attribute; Identity of the application that is instantiating the process. Null in case of stand alone or nested processes.

Supported API: false

See Also:
Constant Field Values

APPLICATION_ID_UPPER_LIMIT

private static int APPLICATION_ID_UPPER_LIMIT

applicationId

private String applicationId

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

WfCreateProcessEventAudit

public WfCreateProcessEventAudit()
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(WfCreateProcessEventAudit 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

getPActivityKey

public long getPActivityKey()
Gets the value of the attribute: P_ACTIVITY_KEY. Identifies activity which is the requester for the newly created process.

Supported API: false

Returns:
long

setPActivityKey

public void setPActivityKey(long a_PActivityKey)
Sets the value of the attribute: P_ACTIVITY_KEY. Identifies activity which is the requester for the newly created process.

Supported API: false

Parameters:
a_PActivityKey -

getPProcessKey

public long getPProcessKey()
Gets the value of the attribute: P_PROCESS_KEY. Identifies process that contains parent activity.

Supported API: false

Returns:
long

setPProcessKey

public void setPProcessKey(long a_PProcessKey)
Sets the value of the attribute: P_PROCESS_KEY. Identifies process that contains parent activity.

Supported API: false

Parameters:
a_PProcessKey -

getPProcessTemplateName

public String getPProcessTemplateName()
Gets the value of the attribute: P_PROCESS_TEMPLATE_NAME. Identifies process template of the parent process.

Supported API: false

Returns:
String

setPProcessTemplateName

public void setPProcessTemplateName(String a_PProcessTemplateName)
Sets the value of the attribute: P_PROCESS_TEMPLATE_NAME. Identifies process template of the parent process.

Supported API: false

Parameters:
a_PProcessTemplateName -

getPProcessTemplateVersion

public String getPProcessTemplateVersion()
Gets the value of the attribute: P_PROCESS_TEMPLATE_VERSION. Identifies the version of the process template of the parent process.

Supported API: false

Returns:
String

setPProcessTemplateVersion

public void setPProcessTemplateVersion(String a_PProcessTemplateVersion)
Sets the value of the attribute: P_PROCESS_TEMPLATE_VERSION. Identifies the version of the process template of the parent process.

Supported API: false

Parameters:
a_PProcessTemplateVersion -

getApplicationId

public String getApplicationId()
Gets the value of the attribute: APPLICATION_ID. Identity of the application that is instantiating the process. Null in case of stand alone or nested processes.

Supported API: false

Returns:
String

setApplicationId

public void setApplicationId(String a_ApplicationId)
Sets the value of the attribute: APPLICATION_ID. Identity of the application that is instantiating the process. Null in case of stand alone or nested processes.

Supported API: false

Parameters:
a_ApplicationId -

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

newWfCreateProcessEventAudit

public static WfCreateProcessEventAudit newWfCreateProcessEventAudit(WTContainerRef container_ref)
                                                              throws WTException


Supported API: false

Parameters:
container_ref -
Returns:
WfCreateProcessEventAudit
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