wt.workflow.definer
Class WfAssignedActivityTemplate

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

All Implemented Interfaces:

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

Direct Known Subclasses:

ProjectActivityTemplate, WfAdHocActivityTemplate

public class WfAssignedActivityTemplate

extends WfTemplateObject

implements Externalizable

Template for creation of assigned activities. Contains a reference to a principal and a role. One of the two must be null (but not both) for the object to generate activity objects.

Serves as a factory for the generation of assined activities.

Use the newWfAssignedActivityTemplate static factory method(s), not the WfAssignedActivityTemplate 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: true

Extendable: false

See Also:

WfAssignedActivity, Serialized Form

Field Summary

protected static String	ACTOR_ROLE_LIST Label for the attribute; List of roles to whom the activity will be assigned.
private static int	ACTOR_ROLE_LIST_UPPER_LIMIT
private RoleVector	actorRoleList
private static String	CLASSNAME
static long	EXTERNALIZATION_VERSION_UID
private String	instructions
static String	INSTRUCTIONS Label for the attribute; Holds instructions to the participant of how to perform task.
private static int	INSTRUCTIONS_UPPER_LIMIT
protected static long	OLD_FORMAT_VERSION_UID
private String	OLD_PROJECT_REFERENCE
private ProjectReference	oldProjectReference
protected static String	PRINCIPAL_REF_LIST Label for the attribute; List of principals to whom the activity will be assigned.
private static int	PRINCIPAL_REF_LIST_UPPER_LIMIT
private PrincipalRefVector	principalRefList
private Vector	principalSourceId
protected static String	PROJECT_REF_LIST Label for the attribute; List of variables that hold references to projects.
private static int	PROJECT_REF_LIST_UPPER_LIMIT
private ProjectRefVector	projectRefList
private static String	RESOURCE
protected static String	ROLE_LIST Label for the attribute; List of roles to be resolved into principals when the activity is started.
private static int	ROLE_LIST_UPPER_LIMIT
private RoleVector	roleList
static String	SEND_NOTIFICATION Label for the attribute; Flag to indicate whether work should be delivered by email or not.
private boolean	sendNotification
(package private) static long	serialVersionUID
static String	SIGNING_REQUIRED Label for the attribute; Used to determine if this Activity needs to be electronically signed at Task Completion.
private boolean	signingRequired
static String	TASK_NAME Label for the attribute; The task this assignment should invoke Supported API: false
private static int	TASK_NAME_UPPER_LIMIT
private String	taskName
protected static String	TEAM_REF_LIST Label for the attribute; List of variables that hold references to teams.
private static int	TEAM_REF_LIST_UPPER_LIMIT
static String	TEAM_REFERENCE Label for the attribute; Identifies a local team to use for role resolution for the associated activities.
static String	TEAM_TEMPLATE_REFERENCE Label for the attribute; Identifies a team to use for role resolution for the associated activities.
static String	TEAM_VARIABLE_NAME Label for the attribute; Identifies by name, the variable holding a project to use for role resolution Supported API: false
private static int	TEAM_VARIABLE_NAME_UPPER_LIMIT
private TeamReference	teamReference
private TeamRefVector	teamRefList
private TeamTemplateReference	teamTemplateReference
private String	teamVariableName
protected static String	VARIABLE_REF_LIST Label for the attribute; List of variables that hold references to principals.
private static int	VARIABLE_REF_LIST_UPPER_LIMIT
private VariableRefVector	variableRefList
private static boolean	VERBOSE

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

WfAssignedActivityTemplate()

Method Summary

boolean	addActorRole(ActorRole actor_role) Adds actor role to template.
boolean	addActorRoleAssignee(WfActorRoleAssignee actorRoleAssignee) Add a WfActorRoleAssignee object to the template.
boolean	addPrincipal(WTPrincipal principal) Add principal to the template.
boolean	addPrincipal(WTPrincipalReference principal_ref) Add principal to the template given a reference to it.
boolean	addPrincipalAssignee(WfPrincipalAssignee principalAssignee) Add a WfPrincipalAssignee object to the template.
boolean	addProject(ProjectReference project_ref) Add prject to the template given a reference to it.
boolean	addProjectAssignee(WfProjectAssignee projectAssignee) Add a WfProjectAssignee object to the template.
boolean	addRole(Role role) Add role to the template.
boolean	addRoleAssignee(WfRoleAssignee roleAssignee) Add af WfRoleAssignee object to the template.
boolean	addTeamAssignee(WfTeamAssignee teamAssignee) Add a WfTeamAssignee object to the template.
boolean	addTeamTemplate(TeamTemplateReference team_template_ref) Add team template to the template given a reference to it.
boolean	addVariable(WfVariableInfo variable) Add variable to the template.
boolean	addVariableAssignee(WfVariableAssignee variableAssignee) Add a WfVariableAssignee object to the template.
protected PrincipalRefVector	convertPRefs(PrincipalRefVector prv)
protected ProjectRefVector	convertProjectRefs(ProjectRefVector prv)
protected RoleVector	convertRoles(RoleVector rv)
protected TeamRefVector	convertTeamRefs(TeamRefVector trv)
protected VariableRefVector	convertVariableRefs(VariableRefVector vrv)
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.
ProjectRefVector	covertGetProjectRefList()
WfNode	createWfNode(WfContainer container) Creates an assigned 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.
Enumeration	getActorRoleAssignees() Returns an enumeration of WfActorRoleAssignee objects in the template.
protected RoleVector	getActorRoleList() Gets the value of the attribute: ACTOR_ROLE_LIST.
Enumeration	getActorRoles() Returns enumeration containing all actor roles in the template.
String	getConceptualClassname() Deprecated.
Class	getExecObjClass() Returns the class of the execution object instantiated by theis class.
String	getInstructions() Gets the value of the attribute: INSTRUCTIONS.
Enumeration	getPrincipalAssignees() Returns an enumeration of WfPrincipalAssignee objects in the template.
protected PrincipalRefVector	getPrincipalRefList() Gets the value of the attribute: PRINCIPAL_REF_LIST.
Enumeration	getPrincipalRefs() Returns an enumeration (of type WTPrincipalReference) of all principals in the template.
Enumeration	getProjectAssignees() Returns an enumeration of WfProjectAssignee objects in the template.
protected ProjectRefVector	getProjectRefList() Gets the value of the attribute: PROJECT_REF_LIST.
Enumeration	getProjectRefs() Returns an enumeration of ProjectReference objects Supported API: false
Enumeration	getRoleAssignees() Returns an enumeration of WfRoleAssignee objects in the template.
protected RoleVector	getRoleList() Gets the value of the attribute: ROLE_LIST.
Enumeration	getRoles() Returns an enumeration (of type Role) of all principals in the template.
String	getTaskName() Gets the value of the attribute: TASK_NAME.
Enumeration	getTeamAssignees() Returns an enumeration of WfTeamAssignee objects in the template.
TeamReference	getTeamReference() Gets the value of the attribute: TEAM_REFERENCE.
protected TeamRefVector	getTeamRefList() Gets the value of the attribute: TEAM_REF_LIST.
Enumeration	getTeamRefs() Returns an enumeration of TeamReference objects Supported API: false
TeamTemplateReference	getTeamTemplateReference() Gets the value of the attribute: TEAM_TEMPLATE_REFERENCE.
Enumeration	getTeamTemplateRefs() Returns an enumeration of TeamTemplateReference objects Supported API: false
String	getTeamVariableName() Gets the value of the attribute: TEAM_VARIABLE_NAME.
Enumeration	getVariableAssignees() Returns an enumeration of WfVariableAssignee objects in the template.
protected VariableRefVector	getVariableRefList() Gets the value of the attribute: VARIABLE_REF_LIST.
int	hashCode() Returns a hash code for this object based upon its ObjectIdentifier.
protected void	initialize() Supported API: false
protected void	initialize(WTContainerRef context_ref) Supported API: false
private void	instructionsValidate(String a_Instructions)
boolean	isSendNotification() Gets the value of the attribute: SEND_NOTIFICATION.
boolean	isSigningRequired() Gets the value of the attribute: SIGNING_REQUIRED.
static WfAssignedActivityTemplate	newWfAssignedActivityTemplate() Deprecated. activities created with this constructor are placed in the classic container.
static WfAssignedActivityTemplate	newWfAssignedActivityTemplate(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(WfAssignedActivityTemplate thisObject, ObjectInput input, long readSerialVersionUID, boolean passThrough, boolean superDone) Reads the non-transient fields of this class from an external source.
boolean	removeActorRole(ActorRole actor_role) Removes actor role from template.
boolean	removeActorRoleAssignee(WfActorRoleAssignee actorRoleAssignee) Remove af WfActorRoleAssignee object from the template.
boolean	removePrincipal(WTPrincipal principal) Remove principal from the template.
boolean	removePrincipal(WTPrincipalReference principal_ref) Remove principal from the template given a reference to it.
boolean	removePrincipalAssignee(WfPrincipalAssignee principalAssignee) Remove a WfPrincipalAssignee object from the template.
boolean	removeProject(ProjectReference project_ref) Remove project from the template.
boolean	removeProjectAssignee(WfProjectAssignee projectAssignee) Remove a WfProjectAssignee object from the template.
boolean	removeRole(Role role) Remove role from the template.
boolean	removeRoleAssignee(WfRoleAssignee roleAssignee) Remove a WfRoleAssignee object from the template.
boolean	removeTeamAssignee(WfTeamAssignee teamAssignee) Remove a WfTeamAssignee object from the template.
boolean	removeTeamTemplate(TeamTemplateReference team_template_ref) Remove team template from the template.
boolean	removeVariable(WfVariableInfo variable) Remove variable from the template.
boolean	removeVariableAssignee(WfVariableAssignee variableAssignee) Remove a WfVariableAssignee from the template.
protected void	setActorRoleList(RoleVector a_ActorRoleList) Sets the value of the attribute: ACTOR_ROLE_LIST.
void	setInstructions(String a_Instructions) Sets the value of the attribute: INSTRUCTIONS.
protected void	setPrincipalRefList(PrincipalRefVector a_PrincipalRefList) Sets the value of the attribute: PRINCIPAL_REF_LIST.
protected void	setProjectRefList(ProjectRefVector a_ProjectRefList) Sets the value of the attribute: PROJECT_REF_LIST.
protected void	setRoleList(RoleVector a_RoleList) Sets the value of the attribute: ROLE_LIST.
void	setSendNotification(boolean a_SendNotification) Sets the value of the attribute: SEND_NOTIFICATION.
void	setSigningRequired(boolean a_SigningRequired) Sets the value of the attribute: SIGNING_REQUIRED.
void	setTaskName(String a_TaskName) Sets the value of the attribute: TASK_NAME.
void	setTeamReference(TeamReference a_TeamReference) Sets the value of the attribute: TEAM_REFERENCE.
protected void	setTeamRefList(TeamRefVector a_TeamRefList) Sets the value of the attribute: TEAM_REF_LIST.
void	setTeamTemplateReference(TeamTemplateReference a_TeamTemplateReference) Sets the value of the attribute: TEAM_TEMPLATE_REFERENCE.
void	setTeamVariableName(String a_TeamVariableName) Sets the value of the attribute: TEAM_VARIABLE_NAME.
protected void	setVariableRefList(VariableRefVector a_VariableRefList) Sets the value of the attribute: VARIABLE_REF_LIST.
private void	teamReferenceValidate(TeamReference a_TeamReference)
private void	teamTemplateReferenceValidate(TeamTemplateReference a_TeamTemplateReference)
private void	teamVariableNameValidate(String a_TeamVariableName)
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.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

PRINCIPAL_REF_LIST

protected static final String PRINCIPAL_REF_LIST

Label for the attribute; List of principals to whom the activity will be assigned. The list is mantained in the form of a vector of references to principals.

Supported API: false

See Also:

Constant Field Values

PRINCIPAL_REF_LIST_UPPER_LIMIT

private static int PRINCIPAL_REF_LIST_UPPER_LIMIT

principalRefList

private PrincipalRefVector principalRefList

ROLE_LIST

protected static final String ROLE_LIST

Label for the attribute; List of roles to be resolved into principals when the activity is started. The mapping between roles and principals is held by the owning process. This default mapping can be overridden if a specific project is passed when the activity is instantiated.

Supported API: false

See Also:

Constant Field Values

ROLE_LIST_UPPER_LIMIT

private static int ROLE_LIST_UPPER_LIMIT

roleList

private RoleVector roleList

TASK_NAME

public static final String TASK_NAME

Label for the attribute; The task this assignment should invoke

Supported API: false

See Also:

Constant Field Values

TASK_NAME_UPPER_LIMIT

private static int TASK_NAME_UPPER_LIMIT

taskName

private String taskName

SEND_NOTIFICATION

public static final String SEND_NOTIFICATION

Label for the attribute; Flag to indicate whether work should be delivered by email or not.

Supported API: false

See Also:

Constant Field Values

sendNotification

private boolean sendNotification

ACTOR_ROLE_LIST

protected static final String ACTOR_ROLE_LIST

Label for the attribute; List of roles to whom the activity will be assigned. The list is mantained in the form of a vector of roles.

Supported API: false

See Also:

Constant Field Values

ACTOR_ROLE_LIST_UPPER_LIMIT

private static int ACTOR_ROLE_LIST_UPPER_LIMIT

actorRoleList

private RoleVector actorRoleList

VARIABLE_REF_LIST

protected static final String VARIABLE_REF_LIST

Label for the attribute; List of variables that hold references to principals. These will become assignees for the activity . The list is mantained in the form of a vector of workflow variable names.

Supported API: false

See Also:

Constant Field Values

VARIABLE_REF_LIST_UPPER_LIMIT

private static int VARIABLE_REF_LIST_UPPER_LIMIT

variableRefList

private VariableRefVector variableRefList

PROJECT_REF_LIST

protected static final String PROJECT_REF_LIST

Label for the attribute; List of variables that hold references to projects. These will become assignees for the activity .

Supported API: false

See Also:

Constant Field Values

PROJECT_REF_LIST_UPPER_LIMIT

private static int PROJECT_REF_LIST_UPPER_LIMIT

projectRefList

private ProjectRefVector projectRefList

TEAM_REFERENCE

public static final String TEAM_REFERENCE

Label for the attribute; Identifies a local team to use for role resolution for the associated activities.

Supported API: false

See Also:

Constant Field Values

teamReference

private TeamReference teamReference

TEAM_VARIABLE_NAME

public static final String TEAM_VARIABLE_NAME

Label for the attribute; Identifies by name, the variable holding a project to use for role resolution

Supported API: false

See Also:

Constant Field Values

TEAM_VARIABLE_NAME_UPPER_LIMIT

private static int TEAM_VARIABLE_NAME_UPPER_LIMIT

teamVariableName

private String teamVariableName

INSTRUCTIONS

public static final String INSTRUCTIONS

Label for the attribute; Holds instructions to the participant of how to perform task. The actual instructions are generated through variable substitution in every place a variable name occurs within curly brackets ('{' and '}'). Also HTML formatting is also allowed.

Supported API: false

See Also:

Constant Field Values

INSTRUCTIONS_UPPER_LIMIT

private static int INSTRUCTIONS_UPPER_LIMIT

instructions

private String instructions

SIGNING_REQUIRED

public static final String SIGNING_REQUIRED

Label for the attribute; Used to determine if this Activity needs to be electronically signed at Task Completion.

Supported API: false

See Also:

Constant Field Values

signingRequired

private boolean signingRequired

TEAM_TEMPLATE_REFERENCE

public static final String TEAM_TEMPLATE_REFERENCE

Label for the attribute; Identifies a team to use for role resolution for the associated activities.

Supported API: false

See Also:

Constant Field Values

teamTemplateReference

private TeamTemplateReference teamTemplateReference

TEAM_REF_LIST

protected static final String TEAM_REF_LIST

Label for the attribute; List of variables that hold references to teams. The principals in these teams will become assignees for the activity .

Supported API: false

See Also:

Constant Field Values

TEAM_REF_LIST_UPPER_LIMIT

private static int TEAM_REF_LIST_UPPER_LIMIT

teamRefList

private TeamRefVector teamRefList

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

VERBOSE

private static final boolean VERBOSE

principalSourceId

private Vector principalSourceId

OLD_PROJECT_REFERENCE

private transient String OLD_PROJECT_REFERENCE

oldProjectReference

private transient ProjectReference oldProjectReference

Constructor Detail

WfAssignedActivityTemplate

public WfAssignedActivityTemplate()

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 WfTemplateObject

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 WfTemplateObject

Parameters:

input -

Throws:

IOException

ClassNotFoundException

readVersion

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

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 WfTemplateObject

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

getPrincipalRefList

protected PrincipalRefVector getPrincipalRefList()

Gets the value of the attribute: PRINCIPAL_REF_LIST. List of principals to whom the activity will be assigned. The list is mantained in the form of a vector of references to principals.

Supported API: false

Returns:

PrincipalRefVector

setPrincipalRefList

protected void setPrincipalRefList(PrincipalRefVector a_PrincipalRefList)

Sets the value of the attribute: PRINCIPAL_REF_LIST. List of principals to whom the activity will be assigned. The list is mantained in the form of a vector of references to principals.

Supported API: false

Parameters:

a_PrincipalRefList -

getRoleList

protected RoleVector getRoleList()

Gets the value of the attribute: ROLE_LIST. List of roles to be resolved into principals when the activity is started. The mapping between roles and principals is held by the owning process. This default mapping can be overridden if a specific project is passed when the activity is instantiated.

Supported API: false

Returns:

RoleVector

setRoleList

protected void setRoleList(RoleVector a_RoleList)

Sets the value of the attribute: ROLE_LIST. List of roles to be resolved into principals when the activity is started. The mapping between roles and principals is held by the owning process. This default mapping can be overridden if a specific project is passed when the activity is instantiated.

Supported API: false

Parameters:

a_RoleList -

getTaskName

public String getTaskName()

Gets the value of the attribute: TASK_NAME. The task this assignment should invoke

Supported API: false

Returns:

String

setTaskName

public void setTaskName(String a_TaskName)

Sets the value of the attribute: TASK_NAME. The task this assignment should invoke

Supported API: false

Parameters:

a_TaskName -

isSendNotification

public boolean isSendNotification()

Gets the value of the attribute: SEND_NOTIFICATION. Flag to indicate whether work should be delivered by email or not.

Supported API: false

Returns:

boolean

setSendNotification

public void setSendNotification(boolean a_SendNotification)

Sets the value of the attribute: SEND_NOTIFICATION. Flag to indicate whether work should be delivered by email or not.

Supported API: false

Parameters:

a_SendNotification -

getActorRoleList

protected RoleVector getActorRoleList()

Gets the value of the attribute: ACTOR_ROLE_LIST. List of roles to whom the activity will be assigned. The list is mantained in the form of a vector of roles.

Supported API: false

Returns:

RoleVector

setActorRoleList

protected void setActorRoleList(RoleVector a_ActorRoleList)

Sets the value of the attribute: ACTOR_ROLE_LIST. List of roles to whom the activity will be assigned. The list is mantained in the form of a vector of roles.

Supported API: false

Parameters:

a_ActorRoleList -

getVariableRefList

protected VariableRefVector getVariableRefList()

Gets the value of the attribute: VARIABLE_REF_LIST. List of variables that hold references to principals. These will become assignees for the activity . The list is mantained in the form of a vector of workflow variable names.

Supported API: false

Returns:

VariableRefVector

setVariableRefList

protected void setVariableRefList(VariableRefVector a_VariableRefList)

Sets the value of the attribute: VARIABLE_REF_LIST. List of variables that hold references to principals. These will become assignees for the activity . The list is mantained in the form of a vector of workflow variable names.

Supported API: false

Parameters:

a_VariableRefList -

getProjectRefList

protected ProjectRefVector getProjectRefList()

Gets the value of the attribute: PROJECT_REF_LIST. List of variables that hold references to projects. These will become assignees for the activity .

Supported API: false

Returns:

ProjectRefVector

setProjectRefList

protected void setProjectRefList(ProjectRefVector a_ProjectRefList)

Sets the value of the attribute: PROJECT_REF_LIST. List of variables that hold references to projects. These will become assignees for the activity .

Supported API: false

Parameters:

a_ProjectRefList -

getTeamReference

public TeamReference getTeamReference()

Gets the value of the attribute: TEAM_REFERENCE. Identifies a local team to use for role resolution for the associated activities.

Supported API: false

Returns:

TeamReference

setTeamReference

public void setTeamReference(TeamReference a_TeamReference)
                      throws WTPropertyVetoException

Sets the value of the attribute: TEAM_REFERENCE. Identifies a local team to use for role resolution for the associated activities.

Supported API: false

Parameters:

a_TeamReference -

Throws:

WTPropertyVetoException

teamReferenceValidate

private void teamReferenceValidate(TeamReference a_TeamReference)
                            throws WTPropertyVetoException

Parameters:

a_TeamReference -

Throws:

WTPropertyVetoException

getTeamVariableName

public String getTeamVariableName()

Gets the value of the attribute: TEAM_VARIABLE_NAME. Identifies by name, the variable holding a project to use for role resolution

Supported API: false

Returns:

String

setTeamVariableName

public void setTeamVariableName(String a_TeamVariableName)
                         throws WTPropertyVetoException

Sets the value of the attribute: TEAM_VARIABLE_NAME. Identifies by name, the variable holding a project to use for role resolution

Supported API: false

Parameters:

a_TeamVariableName -

Throws:

WTPropertyVetoException

teamVariableNameValidate

private void teamVariableNameValidate(String a_TeamVariableName)
                               throws WTPropertyVetoException

Parameters:

a_TeamVariableName -

Throws:

WTPropertyVetoException

getInstructions

public String getInstructions()

Gets the value of the attribute: INSTRUCTIONS. Holds instructions to the participant of how to perform task. The actual instructions are generated through variable substitution in every place a variable name occurs within curly brackets ('{' and '}'). Also HTML formatting is also allowed.

Supported API: false

Returns:

String

setInstructions

public void setInstructions(String a_Instructions)
                     throws WTPropertyVetoException

Sets the value of the attribute: INSTRUCTIONS. Holds instructions to the participant of how to perform task. The actual instructions are generated through variable substitution in every place a variable name occurs within curly brackets ('{' and '}'). Also HTML formatting is also allowed.

Supported API: false

Parameters:

a_Instructions -

Throws:

WTPropertyVetoException

instructionsValidate

private void instructionsValidate(String a_Instructions)
                           throws WTPropertyVetoException

Parameters:

a_Instructions -

Throws:

WTPropertyVetoException

isSigningRequired

public boolean isSigningRequired()

Gets the value of the attribute: SIGNING_REQUIRED. Used to determine if this Activity needs to be electronically signed at Task Completion.

Supported API: false

Returns:

boolean

setSigningRequired

public void setSigningRequired(boolean a_SigningRequired)
                        throws WTPropertyVetoException

Sets the value of the attribute: SIGNING_REQUIRED. Used to determine if this Activity needs to be electronically signed at Task Completion.

Supported API: false

Parameters:

a_SigningRequired -

Throws:

WTPropertyVetoException

getTeamTemplateReference

public TeamTemplateReference getTeamTemplateReference()

Gets the value of the attribute: TEAM_TEMPLATE_REFERENCE. Identifies a team to use for role resolution for the associated activities.

Supported API: false

Returns:

TeamTemplateReference

setTeamTemplateReference

public void setTeamTemplateReference(TeamTemplateReference a_TeamTemplateReference)
                              throws WTPropertyVetoException

Sets the value of the attribute: TEAM_TEMPLATE_REFERENCE. Identifies a team to use for role resolution for the associated activities.

Supported API: false

Parameters:

a_TeamTemplateReference -

Throws:

WTPropertyVetoException

teamTemplateReferenceValidate

private void teamTemplateReferenceValidate(TeamTemplateReference a_TeamTemplateReference)
                                    throws WTPropertyVetoException

Parameters:

a_TeamTemplateReference -

Throws:

WTPropertyVetoException

getTeamRefList

protected TeamRefVector getTeamRefList()

Gets the value of the attribute: TEAM_REF_LIST. List of variables that hold references to teams. The principals in these teams will become assignees for the activity .

Supported API: false

Returns:

TeamRefVector

setTeamRefList

protected void setTeamRefList(TeamRefVector a_TeamRefList)

Sets the value of the attribute: TEAM_REF_LIST. List of variables that hold references to teams. The principals in these teams will become assignees for the activity .

Supported API: false

Parameters:

a_TeamRefList -

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 WfTemplateObject

Returns:

String

createWfNode

public WfNode createWfNode(WfContainer container)
                    throws WTException

Creates an assigned activity from the current template associated with a given process.

Supported API: false

Specified by:

createWfNode in interface WfNodeTemplate

Parameters:

container -

Returns:

WfNode

Throws:

WTException

addPrincipal

public boolean addPrincipal(WTPrincipal principal)
                     throws WTException

Add principal to the template. Returns true if principal didn't belong to the template; false otherwise.

Supported API: false

Parameters:

principal -

Returns:

boolean

Throws:

WTException

removePrincipal

public boolean removePrincipal(WTPrincipal principal)
                        throws WTException

Remove principal from the template. Returns true if principal already belonged to the template; false otherwise.

Supported API: false

Parameters:

principal -

Returns:

boolean

Throws:

WTException

getPrincipalRefs

public Enumeration getPrincipalRefs()

Returns an enumeration (of type WTPrincipalReference) of all principals in the template.

Supported API: false

Returns:

Enumeration

addRole

public boolean addRole(Role role)
                throws WTException

Add role to the template. Returns true if role didn't belong to the template; false otherwise.

Supported API: false

Parameters:

role -

Returns:

boolean

Throws:

WTException

removeRole

public boolean removeRole(Role role)
                   throws WTException

Remove role from the template. Returns true if role did belong to the template; false otherwise.

Supported API: false

Parameters:

role -

Returns:

boolean

Throws:

WTException

getRoles

public Enumeration getRoles()

Returns an enumeration (of type Role) of all principals in the template.

Supported API: false

Returns:

Enumeration

copy

public WfTemplateObject copy()
                      throws WTException

Produces a transient, shallow copy of the object.

Supported API: false

Specified by:

copy in class WfTemplateObject

Returns:

WfTemplateObject

Throws:

WTException

addPrincipal

public boolean addPrincipal(WTPrincipalReference principal_ref)
                     throws WTException

Add principal to the template given a reference to it. Returns true if principal didn't belong to the template; false otherwise.

Supported API: false

Parameters:

principal_ref -

Returns:

boolean

Throws:

WTException

removePrincipal

public boolean removePrincipal(WTPrincipalReference principal_ref)
                        throws WTException

Remove principal from the template given a reference to it. Returns true if principal already belonged to the template; false otherwise.

Supported API: false

Parameters:

principal_ref -

Returns:

boolean

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 WfTemplateObject

Parameters:

template -

addActorRole

public boolean addActorRole(ActorRole actor_role)
                     throws WTException

Adds actor role to template.

Supported API: false

Parameters:

actor_role -

Returns:

boolean

Throws:

WTException

removeActorRole

public boolean removeActorRole(ActorRole actor_role)
                        throws WTException

Removes actor role from template.

Supported API: false

Parameters:

actor_role -

Returns:

boolean

Throws:

WTException

getActorRoles

public Enumeration getActorRoles()

Returns enumeration containing all actor roles in the template.

Supported API: false

Returns:

Enumeration

addVariable

public boolean addVariable(WfVariableInfo variable)
                    throws WTException

Add variable to the template. Returns true if principal didn't belong to the template; false otherwise.

Supported API: false

Parameters:

variable -

Returns:

boolean

Throws:

WTException

removeVariable

public boolean removeVariable(WfVariableInfo variable)
                       throws WTException

Remove variable from the template. Returns true if variable already belonged to the template; false otherwise.

Supported API: false

Parameters:

variable -

Returns:

boolean

Throws:

WTException

addProject

public boolean addProject(ProjectReference project_ref)
                   throws WTException

Add prject to the template given a reference to it. Returns true if prject didn't belong to the template; false otherwise.

Supported API: false

Parameters:

project_ref -

Returns:

boolean

Throws:

WTException

removeProject

public boolean removeProject(ProjectReference project_ref)
                      throws WTException

Remove project from the template.

Supported API: false

Parameters:

project_ref -

Returns:

boolean

Throws:

WTException

getProjectRefs

public Enumeration getProjectRefs()

Returns an enumeration of ProjectReference objects

Supported API: false

Returns:

Enumeration

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

Specified by:

getExecObjClass in class WfTemplateObject

Returns:

Class

getActorRoleAssignees

public Enumeration getActorRoleAssignees()

Returns an enumeration of WfActorRoleAssignee objects in the template.

Supported API: false

Returns:

Enumeration

getPrincipalAssignees

public Enumeration getPrincipalAssignees()

Returns an enumeration of WfPrincipalAssignee objects in the template.

Supported API: false

Returns:

Enumeration

getProjectAssignees

public Enumeration getProjectAssignees()

Returns an enumeration of WfProjectAssignee objects in the template.

Supported API: false

Returns:

Enumeration

getRoleAssignees

public Enumeration getRoleAssignees()

Returns an enumeration of WfRoleAssignee objects in the template.

Supported API: false

Returns:

Enumeration

getVariableAssignees

public Enumeration getVariableAssignees()

Returns an enumeration of WfVariableAssignee objects in the template.

Supported API: false

Returns:

Enumeration

addActorRoleAssignee

public boolean addActorRoleAssignee(WfActorRoleAssignee actorRoleAssignee)

Add a WfActorRoleAssignee object to the template.

Supported API: false

Parameters:

actorRoleAssignee -

Returns:

boolean

addPrincipalAssignee

public boolean addPrincipalAssignee(WfPrincipalAssignee principalAssignee)

Add a WfPrincipalAssignee object to the template.

Supported API: false

Parameters:

principalAssignee -

Returns:

boolean

addProjectAssignee

public boolean addProjectAssignee(WfProjectAssignee projectAssignee)

Add a WfProjectAssignee object to the template.

Supported API: false

Parameters:

projectAssignee -

Returns:

boolean

addRoleAssignee

public boolean addRoleAssignee(WfRoleAssignee roleAssignee)

Add af WfRoleAssignee object to the template.

Supported API: false

Parameters:

roleAssignee -

Returns:

boolean

addVariableAssignee

public boolean addVariableAssignee(WfVariableAssignee variableAssignee)

Add a WfVariableAssignee object to the template.

Supported API: false

Parameters:

variableAssignee -

Returns:

boolean

removeVariableAssignee

public boolean removeVariableAssignee(WfVariableAssignee variableAssignee)

Remove a WfVariableAssignee from the template.

Supported API: false

Parameters:

variableAssignee -

Returns:

boolean

removeRoleAssignee

public boolean removeRoleAssignee(WfRoleAssignee roleAssignee)

Remove a WfRoleAssignee object from the template.

Supported API: false

Parameters:

roleAssignee -

Returns:

boolean

removeProjectAssignee

public boolean removeProjectAssignee(WfProjectAssignee projectAssignee)

Remove a WfProjectAssignee object from the template.

Supported API: false

Parameters:

projectAssignee -

Returns:

boolean

removePrincipalAssignee

public boolean removePrincipalAssignee(WfPrincipalAssignee principalAssignee)

Remove a WfPrincipalAssignee object from the template.

Supported API: false

Parameters:

principalAssignee -

Returns:

boolean

removeActorRoleAssignee

public boolean removeActorRoleAssignee(WfActorRoleAssignee actorRoleAssignee)

Remove af WfActorRoleAssignee object from the template.

Supported API: false

Parameters:

actorRoleAssignee -

Returns:

boolean

getTeamAssignees

public Enumeration getTeamAssignees()

Returns an enumeration of WfTeamAssignee objects in the template.

Supported API: false

Returns:

Enumeration

addTeamAssignee

public boolean addTeamAssignee(WfTeamAssignee teamAssignee)

Add a WfTeamAssignee object to the template.

Supported API: false

Parameters:

teamAssignee -

Returns:

boolean

removeTeamAssignee

public boolean removeTeamAssignee(WfTeamAssignee teamAssignee)

Remove a WfTeamAssignee object from the template.

Supported API: false

Parameters:

teamAssignee -

Returns:

boolean

getTeamRefs

public Enumeration getTeamRefs()

Returns an enumeration of TeamReference objects

Supported API: false

Returns:

Enumeration

addTeamTemplate

public boolean addTeamTemplate(TeamTemplateReference team_template_ref)
                        throws WTException

Add team template to the template given a reference to it. Returns true if team template didn't belong to the template; false otherwise.

Supported API: false

Parameters:

team_template_ref -

Returns:

boolean

Throws:

WTException

getTeamTemplateRefs

public Enumeration getTeamTemplateRefs()

Returns an enumeration of TeamTemplateReference objects

Supported API: false

Returns:

Enumeration

removeTeamTemplate

public boolean removeTeamTemplate(TeamTemplateReference team_template_ref)

Remove team template from the template.

Supported API: false

Parameters:

team_template_ref -

Returns:

boolean

newWfAssignedActivityTemplate

public static WfAssignedActivityTemplate newWfAssignedActivityTemplate()
                                                                throws WTException

Deprecated. activities created with this constructor are placed in the classic container.

Supported API: false

Returns:

WfAssignedActivityTemplate

Throws:

WTException

newWfAssignedActivityTemplate

public static WfAssignedActivityTemplate newWfAssignedActivityTemplate(WTContainerRef context_ref)
                                                                throws WTException

Supported API: false

Parameters:

context_ref -

Returns:

WfAssignedActivityTemplate

Throws:

WTException

copy

public WfTemplateObject copy(WTContainerRef context_ref)
                      throws WTException

Produces a transient, shallow copy of the object.

Supported API: false

Specified by:

copy in class WfTemplateObject

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 WfTemplateObject

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 WfTemplateObject

Returns:

int

initialize

protected void initialize()
                   throws WTException

Description copied from class: Simple

Supported API: false

Overrides:

initialize in class WfTemplateObject

Throws:

WTException

initialize

protected void initialize(WTContainerRef context_ref)
                   throws WTException

Description copied from class: WfTemplateObject

Supported API: false

Overrides:

initialize in class WfTemplateObject

Parameters:

context_ref -

Throws:

WTException

convertRoles

protected RoleVector convertRoles(RoleVector rv)

convertPRefs

protected PrincipalRefVector convertPRefs(PrincipalRefVector prv)

convertProjectRefs

protected ProjectRefVector convertProjectRefs(ProjectRefVector prv)

convertVariableRefs

protected VariableRefVector convertVariableRefs(VariableRefVector vrv)

convertTeamRefs

protected TeamRefVector convertTeamRefs(TeamRefVector trv)

covertGetProjectRefList

public ProjectRefVector covertGetProjectRefList()