wt.workflow.definer
Class WfTemplateObject

java.lang.Object
  wt.fc.WTObject
      wt.enterprise.Simple
          wt.workflow.definer.WfTemplateObject

All Implemented Interfaces:

AccessControlled, BusinessInformation, DisplayIdentification, DomainAdministered, Externalizable, NetFactor, Notifiable, ObjectMappable, Persistable, RecentlyVisited, Serializable, WfNodeTemplate, WTContained

Direct Known Subclasses:

MilestoneTemplate, ProjectProxyTemplate, WfAssignedActivityTemplate, WfContainerTemplate, WfProxyTemplate, WfRobotActivityTemplate

public abstract class WfTemplateObject

extends Simple

implements WfNodeTemplate, WTContained, Externalizable

WfTemplateObject is the base class for the workflow definition objects. It defines meta information about data flow behavior and other attributes.

The association of transitions to expressions is accomplished using the definer service.

Supported API: true

Extendable: false

See Also:

WfExecutionObject, WfRobotActivityTemplate, WfAssignedActivityTemplate, Serialized Form

Field Summary

private WfTemplateCategory	category
static String	CATEGORY Label for the attribute; Classification attribute.
private static int	CATEGORY_UPPER_LIMIT
private static String	CLASSNAME
static String	CONTAINER Label for the attribute.
private WTContainerRef	containerReference
static String	CONTEXT_SIGNATURE Label for the attribute; Map between variable names and their types.
private ProcessDataInfo	contextSignature
private String	description
static String	DESCRIPTION Label for the attribute; Description of the execution object.
private static int	DESCRIPTION_UPPER_LIMIT
private TimeToElapse	duration
static String	DURATION Label for the attribute; Time allowed for the object instantiated from the template to complete.
static String	EVENT_CONFIGURATION Label for the attribute; Stores information about which events are stored and/or emitted during execution of the derived process.
private WfEventConfiguration	eventConfiguration
static long	EXTERNALIZATION_VERSION_UID
static String	ICON_NAME Label for the attribute; Name of the icon associated with object.
private static int	ICON_NAME_UPPER_LIMIT
private String	iconName
private String	name
static String	NAME Label for the attribute; Human readable, descriptive identifier of the execution object.
private static int	NAME_UPPER_LIMIT
protected static long	OLD_FORMAT_VERSION_UID
(package private) static String	ORG_ATTRIBUTE
static String	OVERDUE_NOTIFICATION_LIST Label for the attribute; List of roles of people to be notifified if the execution object becomes overdue.
private static int	OVERDUE_NOTIFICATION_LIST_UPPER_LIMIT
private RoleVector	overdueNotificationList
protected static String	PARENT_LINK_REF Label for the attribute; Reference to the ProcessStepTemplateLink that associates the template object to its parent template.
private ObjectReference	parentLinkRef
private WfContainerTemplateReference	parentTemplate
static String	PROCESS_DURATION Label for the attribute; Time allowed for the object instantiated from the template to complete, counting from the start of the host process execution.
private TimeToElapse	processDuration
static long	R30_EXTERNALIZATION_VERSION_UID
static long	R60_EXTERNALIZATION_VERSION_UID
private static String	RESOURCE
static String	RESPONSIBLE_ROLE Label for the attribute; Role responsible for taking action when the execution object becomes overdue or an exception/abort occurs.
private static int	RESPONSIBLE_ROLE_UPPER_LIMIT
private Role	responsibleRole
private static int	ROUTER_TYPE_UPPER_LIMIT
private WfRouterType	routerType
static String	SELF_VARIABLE_NAME
(package private) static long	serialVersionUID
static String	START_DELAY Label for the attribute; Time in milliseconds the execution of the derived instance should delay measured from the start transition is issued.
static String	START_PROCESS_DELAY Label for the attribute; Time in milliseconds the execution of the derived instance should delay measured from the start of the hosting process.
private TimeToElapse	startDelay
private TimeToElapse	startProcessDelay
static String	TIME_PAST_DEADLINE Label for the attribute; Time in milliseconds the execution after the deadline is reached that a notification is sent to the appropriate parties.
static String	TIME_TO_DEADLINE Label for the attribute; Time in milliseconds the execution before the deadline is reached that a notification is sent to the appropriate parties.
private TimeToElapse	timePastDeadline
private TimeToElapse	timeToDeadline
private static int	USER_EVENT_LIST_UPPER_LIMIT
private UserEventVector	userEventList
private long	xCoord
private long	yCoord

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

WfTemplateObject()

Method Summary

boolean	addOverdueNotificationRole(Role role) Adds role to overdue notification list.
boolean	addUserEvent(Object usr_evt) Adds a user event to the user events of the template object.
private void	containerReferenceValidate(WTContainerRef a_ContainerReference)
abstract WfTemplateObject	copy() Produces a transient, shallow copy of the object.
abstract 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.
boolean	equals(Object obj) Indicates whether the given object is equal to this object from a persistence perspective, by comparing the two objects ObjectIdentifiers.
WfTemplateCategory	getCategory() Gets the value of the attribute: CATEGORY.
WTContainer	getContainer() Gets the object for the association that plays role: CONTAINER.
String	getContainerName() Gets the value of the attribute: CONTAINER_NAME.
WTContainerRef	getContainerReference() Gets the value of the attribute: CONTAINER_REFERENCE.
ProcessDataInfo	getContextSignature() Gets the value of the attribute: CONTEXT_SIGNATURE.
String	getDescription() Gets the value of the attribute: DESCRIPTION.
Enumeration	getDestinationActions() Return all events that can occur with the object as destination of a workflow link.
TimeToElapse	getDuration() Gets the value of the attribute: DURATION.
WfEventConfiguration	getEventConfiguration() Gets the value of the attribute: EVENT_CONFIGURATION.
abstract Class	getExecObjClass() Returns the class of the execution object instantiated by theis class.
String	getIconName() Gets the value of the attribute: ICON_NAME.
String	getIdentity() Returns template's identity.
String	getName() Gets the value of the attribute: NAME.
RoleVector	getOverdueNotificationList() Gets the value of the attribute: OVERDUE_NOTIFICATION_LIST.
Enumeration	getOverdueNotificationRoles() Returns all roles in the overdue notification list.
protected ObjectReference	getParentLinkRef() Gets the value of the attribute: PARENT_LINK_REF.
WfContainerTemplateReference	getParentTemplate() Gets the value of the attribute: PARENT_TEMPLATE.
Enumeration	getPredecessors() This method returns an enumeration (of type NodeTemplateLink) containing the predecessor links of the template.
TimeToElapse	getProcessDuration() Gets the value of the attribute: PROCESS_DURATION.
private WfRequester	getRequester(WfAdHocActivity new_obj)
Role	getResponsibleRole() Gets the value of the attribute: RESPONSIBLE_ROLE.
WfRouterType	getRouterType() Gets the value of the attribute: ROUTER_TYPE.
Enumeration	getSourceEvents() Return all events that can occur with the object as source of a workflow link.
TimeToElapse	getStartDelay() Gets the value of the attribute: START_DELAY.
TimeToElapse	getStartProcessDelay() Gets the value of the attribute: START_PROCESS_DELAY.
Enumeration	getSuccessors() This method returns an enumeration (of type NodeTemplateLink) containing the successor links of the template.
TimeToElapse	getTimePastDeadline() Gets the value of the attribute: TIME_PAST_DEADLINE.
TimeToElapse	getTimeToDeadline() Gets the value of the attribute: TIME_TO_DEADLINE.
UserEventVector	getUserEventList() Gets the value of the attribute: USER_EVENT_LIST.
Object[]	getUserEvents() Returns an array of user-defined events.
long	getXCoord() Gets the value of the attribute: X_COORD.
long	getYCoord() Gets the value of the attribute: Y_COORD.
int	hashCode() Returns a hash code for this object based upon its ObjectIdentifier.
private void	iconNameValidate(String a_IconName)
protected void	initialize() Supported API: false
protected void	initialize(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(WfTemplateObject thisObject, ObjectInput input, long readSerialVersionUID, boolean passThrough, boolean superDone) Reads the non-transient fields of this class from an external source.
boolean	removeOverdueNotificationRole(Role role) Removes role from overdue notification list.
boolean	removeUserEvent(Object usr_evt) Removes a user event from the user events of the template object.
void	setAttributes(WfActivity activity) Convenience method that sets variable mapping and both basic and router attributes.
void	setBasicAttributes(WfExecutionObject new_obj) Sets basic attributes on the execution object passed as argument.
void	setCategory(WfTemplateCategory a_Category) Sets the value of the attribute: CATEGORY.
void	setContainer(WTContainer a_Container) Sets the object for the association that plays role: CONTAINER.
void	setContainerReference(WTContainerRef a_ContainerReference) Sets the value of the attribute: CONTAINER_REFERENCE.
void	setContextSignature(ProcessDataInfo a_ContextSignature) Sets the value of the attribute: CONTEXT_SIGNATURE.
void	setDescription(String a_Description) Sets the value of the attribute: DESCRIPTION.
void	setDuration(TimeToElapse a_Duration) Sets the value of the attribute: DURATION.
void	setEventConfiguration(WfEventConfiguration a_EventConfiguration) Sets the value of the attribute: EVENT_CONFIGURATION.
void	setIconName(String a_IconName) Sets the value of the attribute: ICON_NAME.
void	setLinkRef(ObjectReference link_ref) Temporary work-around to allow setting of the parent link ref.
void	setName(String a_Name) Sets the value of the attribute: NAME.
void	setOverdueNotificationList(RoleVector a_OverdueNotificationList) Sets the value of the attribute: OVERDUE_NOTIFICATION_LIST.
protected void	setParentLinkRef(ObjectReference a_ParentLinkRef) Sets the value of the attribute: PARENT_LINK_REF.
protected void	setParentTemplate(WfContainerTemplateReference a_ParentTemplate) Sets the value of the attribute: PARENT_TEMPLATE.
void	setProcessDuration(TimeToElapse a_ProcessDuration) Sets the value of the attribute: PROCESS_DURATION.
void	setResponsibleRole(Role a_ResponsibleRole) Sets the value of the attribute: RESPONSIBLE_ROLE.
void	setRouterAttributes(WfActivity activity) Sets router attributes on the activity object passed as argument.
void	setRouterType(WfRouterType a_RouterType) Sets the value of the attribute: ROUTER_TYPE.
void	setStartDelay(TimeToElapse a_StartDelay) Sets the value of the attribute: START_DELAY.
void	setStartProcessDelay(TimeToElapse a_StartProcessDelay) Sets the value of the attribute: START_PROCESS_DELAY.
void	setTimePastDeadline(TimeToElapse a_TimePastDeadline) Sets the value of the attribute: TIME_PAST_DEADLINE.
void	setTimeToDeadline(TimeToElapse a_TimeToDeadline) Sets the value of the attribute: TIME_TO_DEADLINE.
void	setUserEventList(UserEventVector a_UserEventList) Sets the value of the attribute: USER_EVENT_LIST.
void	setVariableMapping(WfActivity activity) Sets input/output varible mapping attributes on the activity object passed as argument.
void	setXCoord(long a_XCoord) Sets the value of the attribute: X_COORD.
void	setYCoord(long a_YCoord) Sets the value of the attribute: Y_COORD.
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.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.workflow.definer.WfNodeTemplate

createWfNode

Methods inherited from interface wt.fc.Persistable

checkAttributes, getPersistInfo, getType, setPersistInfo

Methods inherited from interface wt.fc.NetFactor

getClassInfo, getConceptualClassname

Field Detail

RESOURCE

private static final String RESOURCE

See Also:

Constant Field Values

CLASSNAME

private static final String CLASSNAME

NAME

public static final String NAME

Label for the attribute; Human readable, descriptive identifier of the execution object.

Supported API: false

See Also:

Constant Field Values

NAME_UPPER_LIMIT

private static int NAME_UPPER_LIMIT

name

private String name

DESCRIPTION

public static final String DESCRIPTION

Label for the attribute; Description of the execution object.

Supported API: false

See Also:

Constant Field Values

DESCRIPTION_UPPER_LIMIT

private static int DESCRIPTION_UPPER_LIMIT

description

private String description

CATEGORY

public static final String CATEGORY

Label for the attribute; Classification attribute.

Supported API: false

See Also:

Constant Field Values

CATEGORY_UPPER_LIMIT

private static int CATEGORY_UPPER_LIMIT

category

private WfTemplateCategory category

CONTEXT_SIGNATURE

public static final String CONTEXT_SIGNATURE

Label for the attribute; Map between variable names and their types.

Supported API: true

See Also:

Constant Field Values

contextSignature

private ProcessDataInfo contextSignature

ICON_NAME

public static final String ICON_NAME

Label for the attribute; Name of the icon associated with object.

Supported API: false

See Also:

Constant Field Values

ICON_NAME_UPPER_LIMIT

private static int ICON_NAME_UPPER_LIMIT

iconName

private String iconName

DURATION

public static final String DURATION

Label for the attribute; Time allowed for the object instantiated from the template to complete.

Supported API: false

See Also:

Constant Field Values

duration

private TimeToElapse duration

PROCESS_DURATION

public static final String PROCESS_DURATION

Label for the attribute; Time allowed for the object instantiated from the template to complete, counting from the start of the host process execution.

Supported API: false

See Also:

Constant Field Values

processDuration

private TimeToElapse processDuration

EVENT_CONFIGURATION

public static final String EVENT_CONFIGURATION

Label for the attribute; Stores information about which events are stored and/or emitted during execution of the derived process. This attribute is initialized with the defaults specified in the wt.properties file.

Supported API: false

See Also:

Constant Field Values

eventConfiguration

private WfEventConfiguration eventConfiguration

START_DELAY

public static final String START_DELAY

Label for the attribute; Time in milliseconds the execution of the derived instance should delay measured from the start transition is issued.

Supported API: false

See Also:

Constant Field Values

startDelay

private TimeToElapse startDelay

START_PROCESS_DELAY

public static final String START_PROCESS_DELAY

Label for the attribute; Time in milliseconds the execution of the derived instance should delay measured from the start of the hosting process.

Supported API: false

See Also:

Constant Field Values

startProcessDelay

private TimeToElapse startProcessDelay

TIME_TO_DEADLINE

public static final String TIME_TO_DEADLINE

Label for the attribute; Time in milliseconds the execution before the deadline is reached that a notification is sent to the appropriate parties.

Supported API: false

See Also:

Constant Field Values

timeToDeadline

private TimeToElapse timeToDeadline

TIME_PAST_DEADLINE

public static final String TIME_PAST_DEADLINE

Label for the attribute; Time in milliseconds the execution after the deadline is reached that a notification is sent to the appropriate parties.

Supported API: false

See Also:

Constant Field Values

timePastDeadline

private TimeToElapse timePastDeadline

RESPONSIBLE_ROLE

public static final String RESPONSIBLE_ROLE

Label for the attribute; Role responsible for taking action when the execution object becomes overdue or an exception/abort occurs.

Supported API: false

See Also:

Constant Field Values

RESPONSIBLE_ROLE_UPPER_LIMIT

private static int RESPONSIBLE_ROLE_UPPER_LIMIT

responsibleRole

private Role responsibleRole

OVERDUE_NOTIFICATION_LIST

public static final String OVERDUE_NOTIFICATION_LIST

Label for the attribute; List of roles of people to be notifified if the execution object becomes overdue.

Supported API: false

See Also:

Constant Field Values

OVERDUE_NOTIFICATION_LIST_UPPER_LIMIT

private static int OVERDUE_NOTIFICATION_LIST_UPPER_LIMIT

overdueNotificationList

private RoleVector overdueNotificationList

PARENT_LINK_REF

protected static final String PARENT_LINK_REF

Label for the attribute; Reference to the ProcessStepTemplateLink that associates the template object to its parent template. Null in cases of template objects that are not embedded.

Note: the storage of a reference to the link is for performance reasons, to avoid navigating to the link.

Supported API: false

See Also:

Constant Field Values

parentLinkRef

private ObjectReference parentLinkRef

xCoord

private long xCoord

yCoord

private long yCoord

ROUTER_TYPE_UPPER_LIMIT

private static int ROUTER_TYPE_UPPER_LIMIT

routerType

private WfRouterType routerType

USER_EVENT_LIST_UPPER_LIMIT

private static int USER_EVENT_LIST_UPPER_LIMIT

userEventList

private UserEventVector userEventList

parentTemplate

private WfContainerTemplateReference parentTemplate

CONTAINER

public static final String CONTAINER

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

containerReference

private WTContainerRef containerReference

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

R30_EXTERNALIZATION_VERSION_UID

public static final long R30_EXTERNALIZATION_VERSION_UID

See Also:

Constant Field Values

R60_EXTERNALIZATION_VERSION_UID

public static final long R60_EXTERNALIZATION_VERSION_UID

See Also:

Constant Field Values

SELF_VARIABLE_NAME

public static final String SELF_VARIABLE_NAME

See Also:

Constant Field Values

ORG_ATTRIBUTE

static final String ORG_ATTRIBUTE

See Also:

Constant Field Values

Constructor Detail

WfTemplateObject

public WfTemplateObject()

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 Simple

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 Simple

Parameters:

input -

Throws:

IOException

ClassNotFoundException

readVersion

protected boolean readVersion(WfTemplateObject 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 Simple

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 Simple

Parameters:

input -

Throws:

SQLException

DatastoreException

getName

public String getName()

Gets the value of the attribute: NAME. Human readable, descriptive identifier of the execution object.

Supported API: false

Returns:

String

setName

public void setName(String a_Name)

Sets the value of the attribute: NAME. Human readable, descriptive identifier of the execution object.

Supported API: false

Parameters:

a_Name -

getDescription

public String getDescription()

Gets the value of the attribute: DESCRIPTION. Description of the execution object.

Supported API: false

Returns:

String

setDescription

public void setDescription(String a_Description)

Sets the value of the attribute: DESCRIPTION. Description of the execution object.

Supported API: false

Parameters:

a_Description -

getCategory

public WfTemplateCategory getCategory()

Gets the value of the attribute: CATEGORY. Classification attribute.

Supported API: false

Returns:

WfTemplateCategory

setCategory

public void setCategory(WfTemplateCategory a_Category)

Sets the value of the attribute: CATEGORY. Classification attribute.

Supported API: false

Parameters:

a_Category -

getContextSignature

public ProcessDataInfo getContextSignature()

Gets the value of the attribute: CONTEXT_SIGNATURE. Map between variable names and their types.

Supported API: true

Returns:

ProcessDataInfo

setContextSignature

public void setContextSignature(ProcessDataInfo a_ContextSignature)

Sets the value of the attribute: CONTEXT_SIGNATURE. Map between variable names and their types.

Supported API: true

Parameters:

a_ContextSignature -

getIconName

public String getIconName()

Gets the value of the attribute: ICON_NAME. Name of the icon associated with object.

Supported API: false

Returns:

String

setIconName

public void setIconName(String a_IconName)
                 throws WTPropertyVetoException

Sets the value of the attribute: ICON_NAME. Name of the icon associated with object.

Supported API: false

Parameters:

a_IconName -

Throws:

WTPropertyVetoException

iconNameValidate

private void iconNameValidate(String a_IconName)
                       throws WTPropertyVetoException

Parameters:

a_IconName -

Throws:

WTPropertyVetoException

getDuration

public TimeToElapse getDuration()

Gets the value of the attribute: DURATION. Time allowed for the object instantiated from the template to complete.

Supported API: false

Returns:

TimeToElapse

setDuration

public void setDuration(TimeToElapse a_Duration)

Sets the value of the attribute: DURATION. Time allowed for the object instantiated from the template to complete.

Supported API: false

Parameters:

a_Duration -

getProcessDuration

public TimeToElapse getProcessDuration()

Gets the value of the attribute: PROCESS_DURATION. Time allowed for the object instantiated from the template to complete, counting from the start of the host process execution.

Supported API: false

Returns:

TimeToElapse

setProcessDuration

public void setProcessDuration(TimeToElapse a_ProcessDuration)

Sets the value of the attribute: PROCESS_DURATION. Time allowed for the object instantiated from the template to complete, counting from the start of the host process execution.

Supported API: false

Parameters:

a_ProcessDuration -

getEventConfiguration

public WfEventConfiguration getEventConfiguration()

Gets the value of the attribute: EVENT_CONFIGURATION. Stores information about which events are stored and/or emitted during execution of the derived process. This attribute is initialized with the defaults specified in the wt.properties file.

Supported API: false

Returns:

WfEventConfiguration

setEventConfiguration

public void setEventConfiguration(WfEventConfiguration a_EventConfiguration)

Sets the value of the attribute: EVENT_CONFIGURATION. Stores information about which events are stored and/or emitted during execution of the derived process. This attribute is initialized with the defaults specified in the wt.properties file.

Supported API: false

Parameters:

a_EventConfiguration -

getStartDelay

public TimeToElapse getStartDelay()

Gets the value of the attribute: START_DELAY. Time in milliseconds the execution of the derived instance should delay measured from the start transition is issued.

Supported API: false

Returns:

TimeToElapse

setStartDelay

public void setStartDelay(TimeToElapse a_StartDelay)

Sets the value of the attribute: START_DELAY. Time in milliseconds the execution of the derived instance should delay measured from the start transition is issued.

Supported API: false

Parameters:

a_StartDelay -

getStartProcessDelay

public TimeToElapse getStartProcessDelay()

Gets the value of the attribute: START_PROCESS_DELAY. Time in milliseconds the execution of the derived instance should delay measured from the start of the hosting process.

Supported API: false

Returns:

TimeToElapse

setStartProcessDelay

public void setStartProcessDelay(TimeToElapse a_StartProcessDelay)

Sets the value of the attribute: START_PROCESS_DELAY. Time in milliseconds the execution of the derived instance should delay measured from the start of the hosting process.

Supported API: false

Parameters:

a_StartProcessDelay -

getTimeToDeadline

public TimeToElapse getTimeToDeadline()

Gets the value of the attribute: TIME_TO_DEADLINE. Time in milliseconds the execution before the deadline is reached that a notification is sent to the appropriate parties.

Supported API: false

Returns:

TimeToElapse

setTimeToDeadline

public void setTimeToDeadline(TimeToElapse a_TimeToDeadline)
                       throws WTPropertyVetoException

Sets the value of the attribute: TIME_TO_DEADLINE. Time in milliseconds the execution before the deadline is reached that a notification is sent to the appropriate parties.

Supported API: false

Parameters:

a_TimeToDeadline -

Throws:

WTPropertyVetoException

getTimePastDeadline

public TimeToElapse getTimePastDeadline()

Gets the value of the attribute: TIME_PAST_DEADLINE. Time in milliseconds the execution after the deadline is reached that a notification is sent to the appropriate parties.

Supported API: false

Returns:

TimeToElapse

setTimePastDeadline

public void setTimePastDeadline(TimeToElapse a_TimePastDeadline)
                         throws WTPropertyVetoException

Sets the value of the attribute: TIME_PAST_DEADLINE. Time in milliseconds the execution after the deadline is reached that a notification is sent to the appropriate parties.

Supported API: false

Parameters:

a_TimePastDeadline -

Throws:

WTPropertyVetoException

getResponsibleRole

public Role getResponsibleRole()

Gets the value of the attribute: RESPONSIBLE_ROLE. Role responsible for taking action when the execution object becomes overdue or an exception/abort occurs.

Supported API: false

Returns:

Role

setResponsibleRole

public void setResponsibleRole(Role a_ResponsibleRole)

Sets the value of the attribute: RESPONSIBLE_ROLE. Role responsible for taking action when the execution object becomes overdue or an exception/abort occurs.

Supported API: false

Parameters:

a_ResponsibleRole -

getOverdueNotificationList

public RoleVector getOverdueNotificationList()

Gets the value of the attribute: OVERDUE_NOTIFICATION_LIST. List of roles of people to be notifified if the execution object becomes overdue.

Supported API: false

Returns:

RoleVector

setOverdueNotificationList

public void setOverdueNotificationList(RoleVector a_OverdueNotificationList)

Sets the value of the attribute: OVERDUE_NOTIFICATION_LIST. List of roles of people to be notifified if the execution object becomes overdue.

Supported API: false

Parameters:

a_OverdueNotificationList -

getParentLinkRef

protected ObjectReference getParentLinkRef()

Gets the value of the attribute: PARENT_LINK_REF. Reference to the ProcessStepTemplateLink that associates the template object to its parent template. Null in cases of template objects that are not embedded.

Note: the storage of a reference to the link is for performance reasons, to avoid navigating to the link.

Supported API: false

Returns:

ObjectReference

setParentLinkRef

protected void setParentLinkRef(ObjectReference a_ParentLinkRef)

Sets the value of the attribute: PARENT_LINK_REF. Reference to the ProcessStepTemplateLink that associates the template object to its parent template. Null in cases of template objects that are not embedded.

Note: the storage of a reference to the link is for performance reasons, to avoid navigating to the link.

Supported API: false

Parameters:

a_ParentLinkRef -

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 WTObject

Returns:

String

getIdentity

public String getIdentity()

Returns template's identity.

Supported API: false

Specified by:

getIdentity in interface Persistable

Overrides:

getIdentity in class Simple

Returns:

String

getSuccessors

public Enumeration getSuccessors()
                          throws WTException

This method returns an enumeration (of type NodeTemplateLink) containing the successor links of the template. For non-embedded templates, this enumeration is empty, of course.

Supported API: false

Specified by:

getSuccessors in interface WfNodeTemplate

Returns:

Enumeration

Throws:

WTException

getPredecessors

public Enumeration getPredecessors()
                            throws WTException

This method returns an enumeration (of type NodeTemplateLink) containing the predecessor links of the template. For non-embedded templates, this enumeration is empty, of course.

Supported API: false

Specified by:

getPredecessors in interface WfNodeTemplate

Returns:

Enumeration

Throws:

WTException

getSourceEvents

public Enumeration getSourceEvents()

Return all events that can occur with the object as source of a workflow link. Includes transitions and user-defined events.

Supported API: false

Specified by:

getSourceEvents in interface WfNodeTemplate

Returns:

Enumeration

getDestinationActions

public Enumeration getDestinationActions()

Return all events that can occur with the object as destination of a workflow link. Includes only transitions.

Supported API: false

Specified by:

getDestinationActions in interface WfNodeTemplate

Returns:

Enumeration

copyAttributes

protected void copyAttributes(WfTemplateObject template)

Copies all attributes into the template object passed as argument.

Supported API: false

Parameters:

template -

copy

public abstract WfTemplateObject copy()
                               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

Returns:

WfTemplateObject

Throws:

WTException

addUserEvent

public boolean addUserEvent(Object usr_evt)

Adds a user event to the user events of the template object. Returns true if event didn't exist before; false otherwise.

Supported API: false

Specified by:

addUserEvent in interface WfNodeTemplate

Parameters:

usr_evt -

Returns:

boolean

removeUserEvent

public boolean removeUserEvent(Object usr_evt)

Removes a user event from the user events of the template object. Returns true if event did exist before; false otherwise.

Supported API: false

Specified by:

removeUserEvent in interface WfNodeTemplate

Parameters:

usr_evt -

Returns:

boolean

getUserEvents

public Object[] getUserEvents()

Returns an array of user-defined events.

Supported API: false

Specified by:

getUserEvents in interface WfNodeTemplate

Returns:

Object[]

setBasicAttributes

public void setBasicAttributes(WfExecutionObject new_obj)
                        throws WTException

Sets basic attributes on the execution object passed as argument. The basic attributes are name, description, context and template. This method is used internally when a new WfExecutionObject is created.

Supported API: false

Parameters:

new_obj -

Throws:

WTException

setRouterAttributes

public void setRouterAttributes(WfActivity activity)
                         throws WTException

Sets router attributes on the activity object passed as argument. The basic attributes are router type, role, event list and expression key. This method is used internally when a new WfActivity object is created.

Supported API: false

Parameters:

activity -

Throws:

WTException

setVariableMapping

public void setVariableMapping(WfActivity activity)
                        throws WTException

Sets input/output varible mapping attributes on the activity object passed as argument.

Supported API: false

Parameters:

activity -

Throws:

WTException

setAttributes

public void setAttributes(WfActivity activity)
                   throws WTException

Convenience method that sets variable mapping and both basic and router attributes.

Supported API: false

Parameters:

activity -

Throws:

WTException

getOverdueNotificationRoles

public Enumeration getOverdueNotificationRoles()

Returns all roles in the overdue notification list.

Supported API: false

Returns:

Enumeration

addOverdueNotificationRole

public boolean addOverdueNotificationRole(Role role)

Adds role to overdue notification list. Returns true if role didn't belong to the list; false otherwise.

Supported API: false

Parameters:

role -

Returns:

boolean

removeOverdueNotificationRole

public boolean removeOverdueNotificationRole(Role role)

Removes role from overdue notification list. Returns true if role did belong to the list; false otherwise.

Supported API: false

Parameters:

role -

Returns:

boolean

getExecObjClass

public abstract Class getExecObjClass()

Returns the class of the execution object instantiated by theis class. It should be the same returned by the createWfNode method.

Supported API: false

Returns:

Class

initialize

protected void initialize(WTContainerRef context_ref)
                   throws WTException

Supported API: false

Parameters:

context_ref -

Throws:

WTException

copy

public abstract 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

Parameters:

context_ref -

Returns:

WfTemplateObject

Throws:

WTException

getXCoord

public long getXCoord()

Gets the value of the attribute: X_COORD. X coordinate of the template's position.

Supported API: false

Specified by:

getXCoord in interface WfNodeTemplate

Returns:

long

setXCoord

public void setXCoord(long a_XCoord)
               throws WTPropertyVetoException

Sets the value of the attribute: X_COORD. X coordinate of the template's position.

Supported API: false

Specified by:

setXCoord in interface WfNodeTemplate

Parameters:

a_XCoord -

Throws:

WTPropertyVetoException

getYCoord

public long getYCoord()

Gets the value of the attribute: Y_COORD. Y coodinate of the template's position.

Supported API: false

Specified by:

getYCoord in interface WfNodeTemplate

Returns:

long

setYCoord

public void setYCoord(long a_YCoord)
               throws WTPropertyVetoException

Sets the value of the attribute: Y_COORD. Y coodinate of the template's position.

Supported API: false

Specified by:

setYCoord in interface WfNodeTemplate

Parameters:

a_YCoord -

Throws:

WTPropertyVetoException

getRouterType

public WfRouterType getRouterType()

Gets the value of the attribute: ROUTER_TYPE. Type of the router (NONE, MANUAL, or CONDITIONAL).

Supported API: false

Specified by:

getRouterType in interface WfNodeTemplate

Returns:

WfRouterType

setRouterType

public void setRouterType(WfRouterType a_RouterType)

Sets the value of the attribute: ROUTER_TYPE. Type of the router (NONE, MANUAL, or CONDITIONAL).

Supported API: false

Specified by:

setRouterType in interface WfNodeTemplate

Parameters:

a_RouterType -

getUserEventList

public UserEventVector getUserEventList()

Gets the value of the attribute: USER_EVENT_LIST. Event list associated to the node. Makes sense only for router nodes.

Supported API: false

Specified by:

getUserEventList in interface WfNodeTemplate

Returns:

UserEventVector

setUserEventList

public void setUserEventList(UserEventVector a_UserEventList)

Sets the value of the attribute: USER_EVENT_LIST. Event list associated to the node. Makes sense only for router nodes.

Supported API: false

Specified by:

setUserEventList in interface WfNodeTemplate

Parameters:

a_UserEventList -

getParentTemplate

public WfContainerTemplateReference getParentTemplate()

Gets the value of the attribute: PARENT_TEMPLATE. Reference to parent template. Null if template has no parent.

Supported API: false

Specified by:

getParentTemplate in interface WfNodeTemplate

Returns:

WfContainerTemplateReference

setParentTemplate

protected void setParentTemplate(WfContainerTemplateReference a_ParentTemplate)

Sets the value of the attribute: PARENT_TEMPLATE. Reference to parent template. Null if template has no parent.

Supported API: false

Parameters:

a_ParentTemplate -

getContainerName

public String getContainerName()

Gets the value of the attribute: CONTAINER_NAME. The name of the WTContainer this object is assigned to.

Supported API: false

Specified by:

getContainerName in interface WTContained

Returns:

String

getContainer

public WTContainer getContainer()

Gets the object for the association that plays role: CONTAINER.

Supported API: false

Specified by:

getContainer in interface WTContained

Returns:

WTContainer

setContainer

public void setContainer(WTContainer a_Container)
                  throws WTPropertyVetoException,
                         WTException

Sets the object for the association that plays role: CONTAINER.

Supported API: false

Specified by:

setContainer in interface WTContained

Parameters:

a_Container -

Throws:

WTPropertyVetoException

WTException

getContainerReference

public WTContainerRef getContainerReference()

Gets the value of the attribute: CONTAINER_REFERENCE.

Supported API: false

Specified by:

getContainerReference in interface WTContained

Returns:

WTContainerRef

setContainerReference

public void setContainerReference(WTContainerRef a_ContainerReference)
                           throws WTPropertyVetoException

Sets the value of the attribute: CONTAINER_REFERENCE.

Supported API: false

Specified by:

setContainerReference in interface WTContained

Parameters:

a_ContainerReference -

Throws:

WTPropertyVetoException

containerReferenceValidate

private void containerReferenceValidate(WTContainerRef a_ContainerReference)
                                 throws WTPropertyVetoException

Parameters:

a_ContainerReference -

Throws:

WTPropertyVetoException

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 Simple

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 Simple

Returns:

int

initialize

protected void initialize()
                   throws WTException

Description copied from class: Simple

Supported API: false

Overrides:

initialize in class Simple

Throws:

WTException

getRequester

private WfRequester getRequester(WfAdHocActivity new_obj)
                          throws WTException

Throws:

WTException

setLinkRef

public void setLinkRef(ObjectReference link_ref)

Temporary work-around to allow setting of the parent link ref. This is used in copying project plans (com.ptc.netmarkets.ixb.ProjectPlanStructCopyHelper).

In the first opportunity setParentLinkRef should be made public and this method removed as unnecessary.