wt.workflow.definer
Class WfProcessTemplate

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

All Implemented Interfaces:

AccessControlled, BusinessInformation, CabinetBased, DisplayIdentification, DomainAdministered, Externalizable, Foldered, FolderEntry, FolderServiceManaged, Iterated, IteratedFoldered, Lockable, NetFactor, Notifiable, ObjectMappable, Ownable, Persistable, RecentlyVisited, Serializable, WfNodeTemplate, WfProcessDefinition, Workable, WTContained

public class WfProcessTemplate

extends WfContainerTemplate

implements Ownable, WfProcessDefinition, IteratedFoldered, Workable, Externalizable

A WfProcessTemplate represents a template for a specific workflow process; it is used to create instances of a workflow process. Logically it is the factory and locator for WfProcess instances. It also provides access to the meta information about the context a process requires and the result a process produces. A process manager is identified by its name which is unique within a given business domain.

Use the newWfProcessTemplate static factory method(s), not the WfProcessTemplate 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:

WfProcess, Serialized Form

Field Summary

private CheckoutInfo	checkoutInfo
private static String	CLASSNAME
private ControlBranch	controlBranch
private WTPrincipalReference	creator
static String	CREATOR Label for the attribute.
static String	DESCRIPTION Label for the attribute.
static String	ENABLED Label for the attribute.
static long	EXTERNALIZATION_VERSION_UID
private FolderingInfo	folderingInfo
private IterationInfo	iterationInfo
private Lock	lock
static String	MASTER Label for the attribute.
static String	MASTER_REFERENCE Label for the attribute.
private WfProcessTemplateMasterReference	masterReference
static String	NAME Label for the attribute.
protected static long	OLD_FORMAT_VERSION_UID
private Ownership	ownership
private static String	RESOURCE
(package private) static long	serialVersionUID
private static boolean	VERBOSE

Fields inherited from class wt.workflow.definer.WfTemplateObject

CATEGORY, CONTAINER, CONTEXT_SIGNATURE, DURATION, EVENT_CONFIGURATION, ICON_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.ownership.Ownable

OWNERSHIP

Fields inherited from interface wt.fc.Persistable

IDENTITY, PERSIST_INFO, TYPE

Fields inherited from interface wt.vc.Iterated

BRANCH_IDENTIFIER, CONTROL_BRANCH, CREATOR_EMAIL, CREATOR_FULL_NAME, CREATOR_NAME, ITERATION_IDENTIFIER, ITERATION_INFO, ITERATION_NOTE, LATEST_ITERATION, MODIFIER, MODIFIER_EMAIL, MODIFIER_FULL_NAME, MODIFIER_NAME

Fields inherited from interface wt.folder.Foldered

CABINET, CABINET_NAME, FOLDERING_INFO

Fields inherited from interface wt.folder.CabinetBased

CABINET_REFERENCE, FOLDER_PATH, LOCATION

Fields inherited from interface wt.vc.wip.Workable

CHECKOUT_INFO

Fields inherited from interface wt.locks.Lockable

LOCK, LOCK_DATE, LOCK_NOTE, LOCKED, LOCKER, LOCKER_EMAIL, LOCKER_FULL_NAME, LOCKER_NAME

Fields inherited from interface wt.workflow.definer.WfNodeTemplate

PARENT_TEMPLATE, ROUTER_TYPE, USER_EVENT_LIST, X_COORD, Y_COORD

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

WfProcessTemplate()

Method Summary

private void	addElementNoDup(Vector v, Object obj)
private void	addElementsNoDup(Vector v, Enumeration e)
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 a requester activity and a process instantiated from the template given the containing process.
private void	creatorValidate(WTPrincipalReference a_Creator)
boolean	equals(Object obj) Indicates whether the given object is equal to this object from a persistence perspective, by comparing the two objects ObjectIdentifiers.
private Enumeration	getActInBlock(WfContainerTemplate block_def)
private Vector	getAllInnerBlocksRoles(WfBlockTemplate blkTemplate, Vector roleList)
private Vector	getAllRolesFromTemplates(Enumeration enum, Vector role_vector) fetch roles from All types of Templates
private Vector	getAllSubProcessActRoles(WfProxyTemplate proxy, Vector roleList)
private Vector	getAssignedActivityRoles(WfAssignedActivityTemplate template, Vector roleList)
long	getBranchIdentifier() Gets the value of the attribute: BRANCH_IDENTIFIER.
CabinetReference	getCabinet() Gets the value of the attribute: CABINET.
String	getCabinetName() Gets the value of the attribute: CABINET_NAME.
CabinetReference	getCabinetReference() Gets the value of the attribute: CABINET_REFERENCE.
CheckoutInfo	getCheckoutInfo() Gets the object for the association that plays role: CHECKOUT_INFO.
String	getConceptualClassname() Deprecated.
ControlBranch	getControlBranch() Gets the value of the attribute: CONTROL_BRANCH.
WTPrincipalReference	getCreator() Gets the object for the association that plays role: CREATOR.
String	getCreatorEMail() Gets the value of the attribute: CREATOR_EMAIL.
String	getCreatorFullName() Gets the value of the attribute: CREATOR_FULL_NAME.
String	getCreatorName() Gets the value of the attribute: CREATOR_NAME.
String	getDescription() Gets the value of the attribute: DESCRIPTION.
Class	getExecObjClass() Returns the class of the execution object instantiated by theis class.
FolderingInfo	getFolderingInfo() Gets the object for the association that plays role: FOLDERING_INFO.
String	getFolderPath() Gets the value of the attribute: FOLDER_PATH.
String	getIdentity() Returns the identity string associated with the template.
IterationIdentifier	getIterationIdentifier() Gets the value of the attribute: ITERATION_IDENTIFIER.
IterationInfo	getIterationInfo() Gets the object for the association that plays role: ITERATION_INFO.
String	getIterationNote() Gets the value of the attribute: ITERATION_NOTE.
String	getLocation() Gets the value of the attribute: LOCATION.
Lock	getLock() Gets the object for the association that plays role: LOCK.
Timestamp	getLockDate() Gets the value of the attribute: LOCK_DATE.
WTPrincipalReference	getLocker() Gets the value of the attribute: LOCKER.
String	getLockerEMail() Gets the value of the attribute: LOCKER_EMAIL.
String	getLockerFullName() Gets the value of the attribute: LOCKER_FULL_NAME.
String	getLockerName() Gets the value of the attribute: LOCKER_NAME.
String	getLockNote() Gets the value of the attribute: LOCK_NOTE.
Mastered	getMaster() Gets the object for the association that plays role: MASTER.
ObjectReference	getMasterReference() Gets the value of the attribute: MASTER_REFERENCE.
WTPrincipalReference	getModifier() Gets the value of the attribute: MODIFIER.
String	getModifierEMail() Gets the value of the attribute: MODIFIER_EMAIL.
String	getModifierFullName() Gets the value of the attribute: MODIFIER_FULL_NAME.
String	getModifierName() Gets the value of the attribute: MODIFIER_NAME.
String	getName() Gets the value of the attribute: NAME.
Ownership	getOwnership() Gets the object for the association that plays role: OWNERSHIP.
WfProcessTemplate	getProcessTemplate() Returns a specific iteration of a process template.
ObjectReference	getProcessTemplateReference() Returns a reference to a specific iteration of a process template.
Vector	getRequiredRoles()
private Vector	getRobotActivityRoles(WfInternalMethodTemplate template, Vector roleList)
Vector	getRoles()
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
boolean	isEnabled() Gets the value of the attribute: ENABLED.
boolean	isLatestIteration() Gets the value of the attribute: LATEST_ITERATION.
boolean	isLocked() Gets the value of the attribute: LOCKED.
private void	iterationInfoValidate(IterationInfo a_IterationInfo)
private void	lockValidate(Lock a_Lock)
private void	masterReferenceValidate(ObjectReference a_MasterReference)
static WfProcessTemplate	newWfProcessTemplate() Deprecated. activities created with this constructor are placed in the classic container.
static WfProcessTemplate	newWfProcessTemplate(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(WfProcessTemplate thisObject, ObjectInput input, long readSerialVersionUID, boolean passThrough, boolean superDone) Reads the non-transient fields of this class from an external source.
void	setCheckoutInfo(CheckoutInfo a_CheckoutInfo) Sets the object for the association that plays role: CHECKOUT_INFO.
void	setControlBranch(ControlBranch a_ControlBranch) Sets the value of the attribute: CONTROL_BRANCH.
void	setCreator(WTPrincipalReference a_Creator) Sets the object for the association that plays role: CREATOR.
void	setDescription(String a_Description) Sets the value of the attribute: DESCRIPTION.
void	setEnabled(boolean a_Enabled) Sets the value of the attribute: ENABLED.
void	setFolderingInfo(FolderingInfo a_FolderingInfo) Sets the object for the association that plays role: FOLDERING_INFO.
void	setIterationInfo(IterationInfo a_IterationInfo) Sets the object for the association that plays role: ITERATION_INFO.
void	setLock(Lock a_Lock) Sets the object for the association that plays role: LOCK.
void	setMaster(Mastered a_Master) Sets the object for the association that plays role: MASTER.
void	setMasterReference(ObjectReference a_MasterReference) Sets the value of the attribute: MASTER_REFERENCE.
void	setName(String a_Name) Sets the value of the attribute: NAME.
void	setOwnership(Ownership a_Ownership) Sets the object for the association that plays role: OWNERSHIP.
String	toString() Returns a 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.WfContainerTemplate

getEndConnectors, getStartConnector, readVersion

Methods inherited from class wt.workflow.definer.WfTemplateObject

addOverdueNotificationRole, addUserEvent, getCategory, getContainer, getContainerName, getContainerReference, getContextSignature, getDestinationActions, getDuration, getEventConfiguration, getIconName, 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, setDuration, setEventConfiguration, setIconName, setLinkRef, 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

NAME

public static final String NAME

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

DESCRIPTION

public static final String DESCRIPTION

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

ENABLED

public static final String ENABLED

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

MASTER

public static final String MASTER

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

MASTER_REFERENCE

public static final String MASTER_REFERENCE

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

masterReference

private WfProcessTemplateMasterReference masterReference

CREATOR

public static final String CREATOR

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

creator

private WTPrincipalReference creator

ownership

private Ownership ownership

controlBranch

private ControlBranch controlBranch

iterationInfo

private IterationInfo iterationInfo

folderingInfo

private FolderingInfo folderingInfo

checkoutInfo

private CheckoutInfo checkoutInfo

lock

private Lock lock

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

Constructor Detail

WfProcessTemplate

public WfProcessTemplate()

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 WfContainerTemplate

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 WfContainerTemplate

Parameters:

input -

Throws:

IOException

ClassNotFoundException

readVersion

protected boolean readVersion(WfProcessTemplate 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 WfContainerTemplate

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 WfContainerTemplate

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

getName

public String getName()

Gets the value of the attribute: NAME.

Supported API: false

Specified by:

getName in interface WfProcessDefinition

Overrides:

getName in class WfTemplateObject

Returns:

String

setName

public void setName(String a_Name)

Sets the value of the attribute: NAME.

Supported API: false

Overrides:

setName in class WfTemplateObject

Parameters:

a_Name -

getDescription

public String getDescription()

Gets the value of the attribute: DESCRIPTION.

Supported API: false

Overrides:

getDescription in class WfTemplateObject

Returns:

String

setDescription

public void setDescription(String a_Description)

Sets the value of the attribute: DESCRIPTION.

Supported API: false

Overrides:

setDescription in class WfTemplateObject

Parameters:

a_Description -

isEnabled

public boolean isEnabled()

Gets the value of the attribute: ENABLED.

Supported API: false

Specified by:

isEnabled in interface WfProcessDefinition

Returns:

boolean

setEnabled

public void setEnabled(boolean a_Enabled)

Sets the value of the attribute: ENABLED.

Supported API: false

Parameters:

a_Enabled -

getMaster

public Mastered getMaster()

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

Supported API: false

Specified by:

getMaster in interface Iterated

Returns:

Mastered

See Also:

Mastered

setMaster

public void setMaster(Mastered a_Master)
               throws WTPropertyVetoException,
                      WTException

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

Supported API: false

Specified by:

setMaster in interface Iterated

Parameters:

a_Master -

Throws:

WTPropertyVetoException

WTException

See Also:

Mastered

getMasterReference

public ObjectReference getMasterReference()

Gets the value of the attribute: MASTER_REFERENCE.

Supported API: false

Specified by:

getMasterReference in interface Iterated

Returns:

ObjectReference

See Also:

Mastered

setMasterReference

public void setMasterReference(ObjectReference a_MasterReference)
                        throws WTPropertyVetoException

Sets the value of the attribute: MASTER_REFERENCE.

Supported API: false

Specified by:

setMasterReference in interface Iterated

Parameters:

a_MasterReference -

Throws:

WTPropertyVetoException

See Also:

Mastered

masterReferenceValidate

private void masterReferenceValidate(ObjectReference a_MasterReference)
                              throws WTPropertyVetoException

Parameters:

a_MasterReference -

Throws:

WTPropertyVetoException

getCreator

public WTPrincipalReference getCreator()

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

Supported API: false

Specified by:

getCreator in interface Iterated

Returns:

WTPrincipalReference

setCreator

public void setCreator(WTPrincipalReference a_Creator)
                throws WTPropertyVetoException

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

Supported API: false

Parameters:

a_Creator -

Throws:

WTPropertyVetoException

creatorValidate

private void creatorValidate(WTPrincipalReference a_Creator)
                      throws WTPropertyVetoException

Parameters:

a_Creator -

Throws:

WTPropertyVetoException

toString

public String toString()

Returns a 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

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

createWfNode

public WfNode createWfNode(WfContainer container)
                    throws WTException

Creates a requester activity and a process instantiated from the template given the containing process. Returns the requester activity.

Supported API: false

Specified by:

createWfNode in interface WfNodeTemplate

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 WfTemplateObject

Parameters:

template -

getIdentity

public String getIdentity()

Returns the identity string associated with the template. The identity string is unique mongst the process templates and is formed concatenating the domain name with the template name.

Supported API: false

Specified by:

getIdentity in interface Persistable

Overrides:

getIdentity in class WfTemplateObject

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

Specified by:

getExecObjClass in class WfTemplateObject

Returns:

Class

newWfProcessTemplate

public static WfProcessTemplate newWfProcessTemplate()
                                              throws WTException

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

Supported API: false

Returns:

WfProcessTemplate

Throws:

WTException

newWfProcessTemplate

public static WfProcessTemplate newWfProcessTemplate(WTContainerRef context_ref)
                                              throws WTException

Supported API: false

Parameters:

context_ref -

Returns:

WfProcessTemplate

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

getOwnership

public Ownership getOwnership()

Gets the object for the association that plays role: OWNERSHIP. The persistent state for an Ownable object is maintained via the Ownership object. Access to information for the Ownership object should be done via methods on the OwnershipHelper.

Supported API: false

Specified by:

getOwnership in interface Ownable

Returns:

Ownership

setOwnership

public void setOwnership(Ownership a_Ownership)

Sets the object for the association that plays role: OWNERSHIP. The persistent state for an Ownable object is maintained via the Ownership object. Access to information for the Ownership object should be done via methods on the OwnershipHelper.

Supported API: false

Specified by:

setOwnership in interface Ownable

Parameters:

a_Ownership -

getProcessTemplate

public WfProcessTemplate getProcessTemplate()
                                     throws WTException

Returns a specific iteration of a process template. This iteration depends on the type of the class that implements the interface: the latest in case of WfProcessTemplate master or itself for WfProcessTemplate objects.

Supported API: false

Specified by:

getProcessTemplate in interface WfProcessDefinition

Returns:

WfProcessTemplate

Throws:

WTException

getProcessTemplateReference

public ObjectReference getProcessTemplateReference()
                                            throws WTException

Returns a reference to a specific iteration of a process template. This iteration depends on the type of the class that implements the interface: the latest in case of WfProcessTemplate master or itself for WfProcessTemplate objects.

Supported API: false

Specified by:

getProcessTemplateReference in interface WfProcessDefinition

Returns:

ObjectReference

Throws:

WTException

getIterationNote

public String getIterationNote()

Gets the value of the attribute: ITERATION_NOTE. Derived attribute for displaying the iteration's note in query results.

Supported API: false

Specified by:

getIterationNote in interface Iterated

Returns:

String

getCreatorEMail

public String getCreatorEMail()

Gets the value of the attribute: CREATOR_EMAIL. Derived attribute for displaying the iteration creator's E-Mail address in query results.

Supported API: false

Specified by:

getCreatorEMail in interface Iterated

Returns:

String

getCreatorName

public String getCreatorName()

Gets the value of the attribute: CREATOR_NAME. Derived attribute for displaying the iteration creator's name in query results.

Supported API: false

Specified by:

getCreatorName in interface Iterated

Returns:

String

getCreatorFullName

public String getCreatorFullName()

Gets the value of the attribute: CREATOR_FULL_NAME. Derived attribute for displaying the iteration creator's fullname in query results.

Supported API: false

Specified by:

getCreatorFullName in interface Iterated

Returns:

String

getModifier

public WTPrincipalReference getModifier()

Gets the value of the attribute: MODIFIER. Derived attribute for displaying the iteration's modifier in query results.

Supported API: false

Specified by:

getModifier in interface Iterated

Returns:

WTPrincipalReference

getModifierEMail

public String getModifierEMail()

Gets the value of the attribute: MODIFIER_EMAIL. Derived attribute for displaying the iteration modifier's E-Mail address in query results.

Supported API: false

Specified by:

getModifierEMail in interface Iterated

Returns:

String

getModifierName

public String getModifierName()

Gets the value of the attribute: MODIFIER_NAME. Derived attribute for displaying the iteration modifier's name in query results.

Supported API: false

Specified by:

getModifierName in interface Iterated

Returns:

String

getModifierFullName

public String getModifierFullName()

Gets the value of the attribute: MODIFIER_FULL_NAME. Derived attribute for displaying the iteration modifier's fullname in query results.

Supported API: false

Specified by:

getModifierFullName in interface Iterated

Returns:

String

getIterationIdentifier

public IterationIdentifier getIterationIdentifier()

Gets the value of the attribute: ITERATION_IDENTIFIER. Derived attribute for displaying the iteration identifier in query results.

Supported API: false

Specified by:

getIterationIdentifier in interface Iterated

Returns:

IterationIdentifier

getBranchIdentifier

public long getBranchIdentifier()

Gets the value of the attribute: BRANCH_IDENTIFIER. Derived attribute for displaying the iteration's branch identifier in query results.

Supported API: false

Specified by:

getBranchIdentifier in interface Iterated

Returns:

long

isLatestIteration

public boolean isLatestIteration()

Gets the value of the attribute: LATEST_ITERATION. Derived attribute for displaying the iteration "latest" flag in query results.

Supported API: false

Specified by:

isLatestIteration in interface Iterated

Returns:

boolean

getControlBranch

public ControlBranch getControlBranch()

Gets the value of the attribute: CONTROL_BRANCH.

Supported API: false

Specified by:

getControlBranch in interface Iterated

Returns:

ControlBranch

setControlBranch

public void setControlBranch(ControlBranch a_ControlBranch)
                      throws WTPropertyVetoException

Sets the value of the attribute: CONTROL_BRANCH.

Supported API: false

Specified by:

setControlBranch in interface Iterated

Parameters:

a_ControlBranch -

Throws:

WTPropertyVetoException

getIterationInfo

public IterationInfo getIterationInfo()

Gets the object for the association that plays role: ITERATION_INFO. The iteration cookie aggregated in any business object that asserts itself as being iterated.

Supported API: false

Specified by:

getIterationInfo in interface Iterated

Returns:

IterationInfo

See Also:

IterationInfo

setIterationInfo

public void setIterationInfo(IterationInfo a_IterationInfo)
                      throws WTPropertyVetoException

Sets the object for the association that plays role: ITERATION_INFO. The iteration cookie aggregated in any business object that asserts itself as being iterated.

Supported API: false

Specified by:

setIterationInfo in interface Iterated

Parameters:

a_IterationInfo -

Throws:

WTPropertyVetoException

See Also:

IterationInfo

iterationInfoValidate

private void iterationInfoValidate(IterationInfo a_IterationInfo)
                            throws WTPropertyVetoException

Parameters:

a_IterationInfo -

Throws:

WTPropertyVetoException

getCabinetName

public String getCabinetName()

Gets the value of the attribute: CABINET_NAME.

Supported API: false

Specified by:

getCabinetName in interface Foldered

Returns:

String

getCabinet

public CabinetReference getCabinet()

Gets the value of the attribute: CABINET.

Supported API: false

Specified by:

getCabinet in interface Foldered

Returns:

CabinetReference

getFolderingInfo

public FolderingInfo getFolderingInfo()

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

Supported API: false

Specified by:

getFolderingInfo in interface Foldered

Returns:

FolderingInfo

setFolderingInfo

public void setFolderingInfo(FolderingInfo a_FolderingInfo)

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

Supported API: false

Specified by:

setFolderingInfo in interface Foldered

Parameters:

a_FolderingInfo -

getFolderPath

public String getFolderPath()

Gets the value of the attribute: FOLDER_PATH. The complete path for the object. The path includes the location with the name appended. This information is calculated.

Supported API: false

Specified by:

getFolderPath in interface CabinetBased

Returns:

String

getLocation

public String getLocation()

Gets the value of the attribute: LOCATION. The location, described as a path for the object. The location does not include the object's name, but rather indicates what Folder (Cabinet or SubFolder) that the object resides in. This information is calculated.

Supported API: false

Specified by:

getLocation in interface CabinetBased

Returns:

String

getCabinetReference

public CabinetReference getCabinetReference()

Gets the value of the attribute: CABINET_REFERENCE. A reference to the cabinet that the entry is consided part of.

Supported API: false

Specified by:

getCabinetReference in interface CabinetBased

Returns:

CabinetReference

getCheckoutInfo

public CheckoutInfo getCheckoutInfo()

Gets the object for the association that plays role: CHECKOUT_INFO. The WIP cookie aggregated in any business object that asserts itself as being Workable.

Supported API: false

Specified by:

getCheckoutInfo in interface Workable

Returns:

CheckoutInfo

See Also:

CheckoutInfo

setCheckoutInfo

public void setCheckoutInfo(CheckoutInfo a_CheckoutInfo)
                     throws WTPropertyVetoException

Sets the object for the association that plays role: CHECKOUT_INFO. The WIP cookie aggregated in any business object that asserts itself as being Workable.

Supported API: false

Specified by:

setCheckoutInfo in interface Workable

Parameters:

a_CheckoutInfo -

Throws:

WTPropertyVetoException

See Also:

CheckoutInfo

isLocked

public boolean isLocked()

Gets the value of the attribute: LOCKED. Derived attribute for displaying the isSeized value in query results.

Supported API: false

Specified by:

isLocked in interface Lockable

Returns:

boolean

getLockDate

public Timestamp getLockDate()

Gets the value of the attribute: LOCK_DATE. Derived attribute for displaying the lock date value in query results.

Supported API: false

Specified by:

getLockDate in interface Lockable

Returns:

Timestamp

getLockNote

public String getLockNote()

Gets the value of the attribute: LOCK_NOTE. Derived attribute for displaying the lock note value in query results.

Supported API: false

Specified by:

getLockNote in interface Lockable

Returns:

String

getLocker

public WTPrincipalReference getLocker()

Gets the value of the attribute: LOCKER. Derived attribute for querying for the locker.

Supported API: false

Specified by:

getLocker in interface Lockable

Returns:

WTPrincipalReference

getLockerEMail

public String getLockerEMail()

Gets the value of the attribute: LOCKER_EMAIL. Derived attribute for displaying the locker E-Mail value in query results.

Supported API: false

Specified by:

getLockerEMail in interface Lockable

Returns:

String

getLockerName

public String getLockerName()

Gets the value of the attribute: LOCKER_NAME. Derived attribute for displaying the locker name value in query results.

Supported API: false

Specified by:

getLockerName in interface Lockable

Returns:

String

getLockerFullName

public String getLockerFullName()

Gets the value of the attribute: LOCKER_FULL_NAME. Derived attribute for displaying the lock fullname value in query results.

Supported API: false

Specified by:

getLockerFullName in interface Lockable

Returns:

String

getLock

public Lock getLock()

Gets the object for the association that plays role: LOCK. The lock mechanism/cookie aggregated in any business object that asserts itself as being lockable.

Supported API: false

Specified by:

getLock in interface Lockable

Returns:

Lock

See Also:

Lock

setLock

public void setLock(Lock a_Lock)
             throws WTPropertyVetoException

Sets the object for the association that plays role: LOCK. The lock mechanism/cookie aggregated in any business object that asserts itself as being lockable.

Supported API: false

Specified by:

setLock in interface Lockable

Parameters:

a_Lock -

Throws:

WTPropertyVetoException

See Also:

Lock

lockValidate

private void lockValidate(Lock a_Lock)
                   throws WTPropertyVetoException

Parameters:

a_Lock -

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 WfContainerTemplate

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 WfContainerTemplate

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

getRoles

public Vector getRoles()
                throws WTException,
                       WfException

Throws:

WTException

WfException

getRequiredRoles

public Vector getRequiredRoles()
                        throws WTException,
                               WfException

Throws:

WTException

WfException

addElementsNoDup

private void addElementsNoDup(Vector v,
                              Enumeration e)

addElementNoDup

private void addElementNoDup(Vector v,
                             Object obj)

getAllSubProcessActRoles

private Vector getAllSubProcessActRoles(WfProxyTemplate proxy,
                                        Vector roleList)
                                 throws WTException

Throws:

WTException

getAllInnerBlocksRoles

private Vector getAllInnerBlocksRoles(WfBlockTemplate blkTemplate,
                                      Vector roleList)
                               throws WfException,
                                      WTException

Throws:

WfException

WTException

getActInBlock

private Enumeration getActInBlock(WfContainerTemplate block_def)
                           throws WfException,
                                  WTException

Throws:

WfException

WTException

getRobotActivityRoles

private Vector getRobotActivityRoles(WfInternalMethodTemplate template,
                                     Vector roleList)
                              throws WTException

Throws:

WTException

getAssignedActivityRoles

private Vector getAssignedActivityRoles(WfAssignedActivityTemplate template,
                                        Vector roleList)
                                 throws WTException

Throws:

WTException

getAllRolesFromTemplates

private Vector getAllRolesFromTemplates(Enumeration enum,
                                        Vector role_vector)
                                 throws WTException,
                                        WfException

fetch roles from All types of Templates

Throws:

WTException

WfException