wt.workflow.definer
Class WfAdHocActivityTemplate

java.lang.Object
  extended bywt.fc.WTObject
      extended bywt.enterprise.Simple
          extended bywt.workflow.definer.WfTemplateObject
              extended bywt.workflow.definer.WfAssignedActivityTemplate
                  extended bywt.workflow.definer.WfAdHocActivityTemplate
All Implemented Interfaces:
AccessControlled, BusinessInformation, DisplayIdentification, DomainAdministered, Externalizable, NetFactor, Notifiable, ObjectMappable, Persistable, RecentlyVisited, Serializable, WfNodeTemplate, WTContained

public class WfAdHocActivityTemplate
extends WfAssignedActivityTemplate
implements Externalizable

Use the newWfAdHocActivityTemplate static factory method(s), not the WfAdHocActivityTemplate 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
           
protected static long OLD_FORMAT_VERSION_UID
           
private static String RESOURCE
           
(package private) static long serialVersionUID
           
 
Fields inherited from class wt.workflow.definer.WfAssignedActivityTemplate
ACTOR_ROLE_LIST, INSTRUCTIONS, PRINCIPAL_REF_LIST, PROJECT_REF_LIST, ROLE_LIST, SEND_NOTIFICATION, SIGNING_REQUIRED, TASK_NAME, TEAM_REF_LIST, TEAM_REFERENCE, TEAM_TEMPLATE_REFERENCE, TEAM_VARIABLE_NAME, VARIABLE_REF_LIST
 
Fields inherited from class wt.workflow.definer.WfTemplateObject
CATEGORY, CONTAINER, CONTEXT_SIGNATURE, DESCRIPTION, DURATION, EVENT_CONFIGURATION, ICON_NAME, NAME, ORG_ATTRIBUTE, OVERDUE_NOTIFICATION_LIST, PARENT_LINK_REF, PROCESS_DURATION, R30_EXTERNALIZATION_VERSION_UID, R60_EXTERNALIZATION_VERSION_UID, RESPONSIBLE_ROLE, SELF_VARIABLE_NAME, START_DELAY, START_PROCESS_DELAY, TIME_PAST_DEADLINE, TIME_TO_DEADLINE
 
Fields inherited from class wt.enterprise.Simple
 
Fields inherited from class wt.fc.WTObject
CREATE_TIMESTAMP, MODIFY_TIMESTAMP
 
Fields inherited from interface wt.workflow.definer.WfNodeTemplate
PARENT_TEMPLATE, ROUTER_TYPE, USER_EVENT_LIST, X_COORD, Y_COORD
 
Fields inherited from interface wt.fc.Persistable
IDENTITY, PERSIST_INFO, TYPE
 
Fields inherited from interface wt.inf.container.WTContained
CONTAINER_ID, CONTAINER_NAME, CONTAINER_REFERENCE
 
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.identity.DisplayIdentification
DISPLAY_IDENTIFIER, DISPLAY_IDENTITY, DISPLAY_TYPE
 
Constructor Summary
WfAdHocActivityTemplate()
           
 
Method Summary
 WfTemplateObject copy()
          Produces a transient, shallow copy of the object.
 WfTemplateObject copy(WTContainerRef context_ref)
          Produces a transient, shallow copy of the object.
protected  void copyAttributes(WfTemplateObject template)
          Copies all attributes into the template object passed as argument.
 WfNode createWfNode(WfContainer container)
          Creates an ad hoc activity from the current template associated with a given process.
 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.  
 Class getExecObjClass()
          Returns the class of the execution object instantiated by theis class.
 int hashCode()
          Returns a hash code for this object based upon its ObjectIdentifier.
static WfAdHocActivityTemplate newWfAdHocActivityTemplate()
          Deprecated. activities created with this constructor are placed in the classic container.
static WfAdHocActivityTemplate newWfAdHocActivityTemplate(WTContainerRef context_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(WfAdHocActivityTemplate thisObject, ObjectInput input, long readSerialVersionUID, boolean passThrough, boolean superDone)
          Reads the non-transient fields of this class from an external source.
 String toString()
          Returns string representation of the 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.definer.WfAssignedActivityTemplate
addActorRole, addActorRoleAssignee, addPrincipal, addPrincipal, addPrincipalAssignee, addProject, addProjectAssignee, addRole, addRoleAssignee, addTeamAssignee, addTeamTemplate, addVariable, addVariableAssignee, convertPRefs, convertProjectRefs, convertRoles, convertTeamRefs, convertVariableRefs, covertGetProjectRefList, getActorRoleAssignees, getActorRoleList, getActorRoles, getInstructions, getPrincipalAssignees, getPrincipalRefList, getPrincipalRefs, getProjectAssignees, getProjectRefList, getProjectRefs, getRoleAssignees, getRoleList, getRoles, getTaskName, getTeamAssignees, getTeamReference, getTeamRefList, getTeamRefs, getTeamTemplateReference, getTeamTemplateRefs, getTeamVariableName, getVariableAssignees, getVariableRefList, initialize, initialize, isSendNotification, isSigningRequired, newWfAssignedActivityTemplate, newWfAssignedActivityTemplate, readVersion, removeActorRole, removeActorRoleAssignee, removePrincipal, removePrincipal, removePrincipalAssignee, removeProject, removeProjectAssignee, removeRole, removeRoleAssignee, removeTeamAssignee, removeTeamTemplate, removeVariable, removeVariableAssignee, setActorRoleList, setInstructions, setPrincipalRefList, setProjectRefList, setRoleList, setSendNotification, setSigningRequired, setTaskName, setTeamReference, setTeamRefList, setTeamTemplateReference, setTeamVariableName, setVariableRefList
 
Methods inherited from class wt.workflow.definer.WfTemplateObject
addOverdueNotificationRole, addUserEvent, getCategory, getContainer, getContainerName, getContainerReference, getContextSignature, getDescription, getDestinationActions, getDuration, getEventConfiguration, getIconName, getIdentity, getName, getOverdueNotificationList, getOverdueNotificationRoles, getParentLinkRef, getParentTemplate, getPredecessors, getProcessDuration, getResponsibleRole, getRouterType, getSourceEvents, getStartDelay, getStartProcessDelay, getSuccessors, getTimePastDeadline, getTimeToDeadline, getUserEventList, getUserEvents, getXCoord, getYCoord, readVersion, removeOverdueNotificationRole, removeUserEvent, setAttributes, setBasicAttributes, setCategory, setContainer, setContainerReference, setContextSignature, setDescription, setDuration, setEventConfiguration, setIconName, setLinkRef, setName, setOverdueNotificationList, setParentLinkRef, setParentTemplate, setProcessDuration, setResponsibleRole, setRouterAttributes, setRouterType, setStartDelay, setStartProcessDelay, setTimePastDeadline, setTimeToDeadline, setUserEventList, setVariableMapping, setXCoord, setYCoord
 
Methods inherited from class wt.enterprise.Simple
getBusinessType, getDomainRef, getEventSet, 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.Persistable
checkAttributes, getPersistInfo, getType, setPersistInfo
 
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

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

WfAdHocActivityTemplate

public WfAdHocActivityTemplate()
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 WfAssignedActivityTemplate
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 WfAssignedActivityTemplate
Parameters:
input -
Throws:
IOException
ClassNotFoundException

readVersion

protected boolean readVersion(WfAdHocActivityTemplate 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 WfAssignedActivityTemplate
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 WfAssignedActivityTemplate
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
Overrides:
getConceptualClassname in class WfAssignedActivityTemplate
Returns:
String

createWfNode

public WfNode createWfNode(WfContainer container)
                    throws WTException
Creates an ad hoc activity from the current template associated with a given process.

Supported API: false

Specified by:
createWfNode in interface WfNodeTemplate
Overrides:
createWfNode in class WfAssignedActivityTemplate
Parameters:
container -
Returns:
WfNode
Throws:
WTException

copyAttributes

protected void copyAttributes(WfTemplateObject template)
Copies all attributes into the template object passed as argument.

Supported API: false

Overrides:
copyAttributes in class WfAssignedActivityTemplate
Parameters:
template -

copy

public WfTemplateObject copy()
                      throws WTException
Produces a transient, shallow copy of the object.

Supported API: false

Overrides:
copy in class WfAssignedActivityTemplate
Returns:
WfTemplateObject
Throws:
WTException

toString

public String toString()
Returns string representation of the object. Used mostly for debugging purposes: not appropriate for GUI use.

Supported API: false

Overrides:
toString in class WfAssignedActivityTemplate
Returns:
String

getExecObjClass

public Class getExecObjClass()
Returns the class of the execution object instantiated by theis class. It is the same returned by the createWfNode method.

Supported API: false

Overrides:
getExecObjClass in class WfAssignedActivityTemplate
Returns:
Class

newWfAdHocActivityTemplate

public static WfAdHocActivityTemplate newWfAdHocActivityTemplate()
                                                          throws WTException
Deprecated. activities created with this constructor are placed in the classic container.



Supported API: false

Returns:
WfAdHocActivityTemplate
Throws:
WTException

newWfAdHocActivityTemplate

public static WfAdHocActivityTemplate newWfAdHocActivityTemplate(WTContainerRef context_ref)
                                                          throws WTException


Supported API: false

Parameters:
context_ref -
Returns:
WfAdHocActivityTemplate
Throws:
WTException

copy

public WfTemplateObject copy(WTContainerRef context_ref)
                      throws WTException
Produces a transient, shallow copy of the object. This method is abstract and should be implemented by all concrete subclasses of WfTemplateObject.

Supported API: false

Overrides:
copy in class WfAssignedActivityTemplate
Parameters:
context_ref -
Returns:
WfTemplateObject
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 WfAssignedActivityTemplate
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 WfAssignedActivityTemplate
Returns:
int