wt.lifecycle
Interface LifeCycleService

All Known Implementing Classes:

LifeCycleServiceFwd, StandardLifeCycleService

public interface LifeCycleService

LifeCycleService provides client invokable methods to life cycle services. These methods are executed on the server side.

Supported API: true

Extendable: false

Method Summary

State[]	allStates() Deprecated. in R4.0. Use the appropriate call on the EnumeratedType object to get these values.
Phase	augmentRoles(LifeCycleManaged object) Given a LifeCycleManaged object, the current State of the Object and the RoleHolder (the phase object), change the role participants to reflect those in the RoleHolder2 Supported API: true
void	augmentRoles(Team team) Given a team, rebuild all the ad hoc acls for objects associated with the team.
boolean	canCreateLifeCycleTemplate(WTUser user) Determines if a given user is entitled to create a Life Cycle Templates.
boolean	canCreateLifeCycleTemplate(WTUser user, WTContainerRef context) Determines if a given user is entitled to create a Life Cycle Templates in the given container.
LifeCycleTemplate	copyTemplate(LifeCycleTemplate lifeCycleTemplate, String copyName, String folderLocation) Produces a copy of the LifeCycleTemplate object and persists it with the name passed as argument.
LifeCycleTemplate	copyTemplate(LifeCycleTemplate lifeCycleTemplate, String copyName, String folderLocation, WTContainerRef context) Produces a copy of the LifeCycleTemplate object and persists it with the name passed as argument.
void	createDefaultTransitions(WTCollection lifeCycleTemplates) Creates all default transitions for all life cycle templates in the specirfied collection, according to the directives specified in the wt.properties system configuration.
LifeCycleSignature	createLifeCycleSignature(Persistable object, WTPrincipal signer, String comments, Role role, boolean vote) Answer an initialized but unpersisted LifeCycleSignature instance Supported API: true
LifeCycleManaged	demote(LifeCycleManaged object, LifeCycleSignature signature) Move the object to the previous phase.
LifeCycleManaged	deny(LifeCycleManaged object, LifeCycleSignature signature) Remove the object from the gate and return the object to the submitter Supported API: true
LifeCycleManaged	drop(LifeCycleManaged object, LifeCycleSignature signature) Transition the object to an end state Supported API: true
void	exportTemplates(Vector lifeCycleVector, String fileName, boolean appendFlag) Populate a file with the xml equivalent of the LifeCycleTemplate objects.
QueryResult	findAllTemplateMasters(WTContainerRef context) Answer a vector of all life cycle template masters for the WTContainerRef passed.
Vector	findAllTemplates() Answer a vector of all life cycle templates.
Vector	findAllTemplates(WTContainerRef context) Answer a vector of all life cycle templates for the WTContainerRef passed.
Vector	findAllTemplates(WTContainerRef context, boolean routingOnly) Answer a vector of all life cycle templates for the WTContainerRef passed.
Vector	findAssociatedProcesses(LifeCycleManaged object, WfState state) Given a Life Cycle Managed object, return the Workflow processes associated with the current phase.
Vector	findCandidateMasterReferences(Class targetClass) Answer a vector of life cycle template references valid for the class Supported API: true
Vector	findCandidateMasterReferences(Class targetClass, WTContainerRef context) Answer a vector of life cycle template references valid for the target class in the container.
Vector	findCandidateMasterReferences(LifeCycleManaged object) Answer a vector of life cycle template references valid for the life cycle managed object Supported API: true
Vector	findCandidateTemplates(Class targetClass) Answer a vector of enabled life cycle template references valid for the class findCandidateMasterReference is the preferable to use instead of this method.
Vector	findCandidateTemplates(LifeCycleManaged object) Answer a vector of enabled life cycle template references valid for the life cycle managed object findCandidateMasterReference is the preferable to use instead of this method.
Vector	findExportImportFileNames() Retrieve a vector of file names from the Import/Export directory Supported API: true
Enumeration	findPredecessorStates(LifeCycleManaged object) Given a particular LifeCycleManged object, answer an enumeration of all the predecessor States Supported API: true
Vector	findRoutingTemplates(WTContainerRef context) Return an Enumeration of all lifecycle templates for the WTContainerRef passed.
WTKeyedMap	findSetStateCandidates(WTCollection lcms) Determines the allowable states the session principal can set the objects in the collection to.
Vector	findStates(LifeCycleTemplate aLifeCycleTemplate) Given a particular LifeCycleTemplate, answer a Vector of all the Life Cycle States used in that LifeCycle Supported API: true
Enumeration	findSuccessorStates(LifeCycleManaged object) Given a particular LifeCycleTemplate, answer an enumeration of all the Successor States Supported API: true
Set	findTransitions(WTSet promotables) For a given Set of promotables return the intersection of thier common Transitions.
Set	findTransitions(WTSet promotables, Transition transition) For a given Set of Promotables, return the intersection of common Transitions.
Vector	getAllReviewerList(LifeCycleManaged object) Answer a vector of LifeCycleSignatures Supported API: true
Vector	getAllSignatures(LifeCycleManaged object) Answer a vector of signatures for all roles for the object for the current phase and all preceeding phases.
Vector	getCriteria(LifeCycleManaged object) Answer a vector of Criterion objects for the current phase Supported API: true
ArrayList	getCriterion(LifeCycleHistory history) returns an ArrayList of Criterion for a LifeCycleHistory Supported API: false
Phase	getCurrentPhase(LifeCycleManaged object) Deprecated. at R4.0 - This method should not be used outside of the Life Cycle service. This phase object should be considered private to LifeCycle. If you have a need to access information on this object, please send a detailed request via Windchill Technical Marketing.
ObjectReference	getCurrentWorkflow(LifeCycleManaged object) Given a LifeCycleManaged object, return a reference to the current WfProcess.
QueryResult	getHistory(LifeCycleManaged object) Answer an enumeration of LifeCycleHistory objects based on supplied object.
LifeCycleTemplate	getLatestIteration(LifeCycleTemplateMaster master) Given a LifeCycleTemplateMaster, return the latest iteration (LifeCycleTemplate) Supported API: true
LifeCycleTemplateReference	getLatestIteration(LifeCycleTemplateMasterReference master) Given a LifeCycleTemplateMasterReference, return the latest iteration (LifeCycleTemplateReference) Supported API: true
LifeCycleTemplate	getLifeCycleTemplate(LifeCycleManaged object) Deprecated. in R4.0 - Use myObject.getLifeCycleTemplate() instead.
LifeCycleTemplate	getLifeCycleTemplate(String aTemplateName) Given a String representation of the LifeCycleTemplate name, answer the LifeCycleTemplate.
LifeCycleTemplate	getLifeCycleTemplate(String aTemplateName, WTContainerRef context) Given a String representation of the LifeCycleTemplate name and a WTContainerRef, answer the LifeCycleTemplate.
LifeCycleTemplateMaster	getLifeCycleTemplateMaster(String aMasterName) Given a String representation of the LifeCycleTemplateMaster name, answer the LifeCycleTemplateMasterReference Supported API: true
LifeCycleTemplateMaster	getLifeCycleTemplateMaster(String aMasterName, WTContainerRef context) Given a String representation of the LifeCycleTemplateMaster name and a WTContainerRef, answer the LifeCycleTemplateMasterReference Supported API: true
LifeCycleTemplateReference	getLifeCycleTemplateReference(String aName) Given a String representation of the LifeCycleTemplater name, find the latest iteration or working copy of the LifeCycleTemplate.
LifeCycleTemplateReference	getLifeCycleTemplateReference(String aName, WTContainerRef context) Given a String representation of the LifeCycleTemplater name and a WTContainerRef, find the latest iteration or working copy of the LifeCycleTemplate.
Vector	getPhaseTemplates(LifeCycleTemplate template) Given a LifeCycleTemplate, return a vector of all the PhaseTemplate objects Supported API: true
State	getPredecessorState(LifeCycleManaged lcmObject) This operation determines the current state of the object and returns the predecessor state for the object.
Vector	getReviewerList(LifeCycleManaged object) Answer a vector of LifeCycleSignatures Supported API: true
Vector	getRoles(LifeCycleManaged object) Answer a vector of strings - role names for the current phase Supported API: true
WTKeyedMap	getSeriesSelectors(WTSet lcms) Given a WTSet of objects, returns a WTKeyedMap whose keys are those elements of the argument set that are LifeCycleManaged and whose values are the keys' corresponding SeriesRangeSelector values for their current states, if applicable.
ArrayList	getSignatures(LifeCycleHistory history) returns an ArrayList of LifeCycleSignatures for a LifeCycleHistory Supported API: false
Vector	getSignatures(LifeCycleManaged object) Answer a vector of signatures for all roles for the object for the current phase.
Vector	getSignatures(LifeCycleManaged object, Role role) Answer a vector of LifeCycleSignature for the current phase based on object and role.
Vector	getSignatures(LifeCycleManaged object, WTUser user) Answer a vector of LifeCycleSignatures based on supplied object & user.
Vector	getSignatures(LifeCycleManaged object, WTUser user, Role role) Answer a vector of LifeCycleSignature for the current phase based on object, user and role.
String	getStateLink(LifeCycleManaged object) Deprecated. at 5.0
State	getSuccessorState(LifeCycleManaged lcmObject) This operation determines the current state of the object and returns the successor state for the object.
boolean	hasAugmentRoleAccess(Role role, LifeCycleManaged object) Given a role and a LifeCycleManaged object, determines whether the current user has the permissions required to update the role participants Supported API: true
void	importTemplates(String fileName) Given a WTContainerRef and a jar or zip file that contains a version of any number of LifeCycleTemplate objects, import these objects.
void	importTemplates(String fileName, WTContainerRef context) Given a WTContainerRef and a jar or zip file that contains a version of any number of LifeCycleTemplate objects, import these objects.
boolean	isA(LifeCycleManaged object, WTUser user, Role role) Deprecated. at 8.0. A user no longer has to belong to a specific role in order to complete a lifecycle task
boolean	isInFinalPhase(LifeCycleManaged object) Answers whether the LifeCycleManaged object is in the Final phase of its LifeCycle Supported API: true
boolean	isInInitialPhase(LifeCycleManaged object) Answer whether the LifeCycleManaged object is in the Initial phase Supported API: true
boolean	isState(LifeCycleTemplate aLifeCycleTemplate, State aState) Given a particular LifeCycleTemplate and a State, answer whether or not the State is used in the LifeCycle Supported API: true
Set	navigate(LifeCycleManaged lcmObject, Transition name, boolean successor) Navigate the transition of the current state of the LifeCycleManagedObject using the passed transition.
Set	navigate(LifeCycleTemplateReference lctRef, State state, Transition transition, boolean successor) Navigate the transition from the passed state using the passed transition.
Map	navigate(WTCollection c, Transition transition, boolean successor) Navigate the PhaseSuccessors for the Transition for all objects in the WTCollection.
Map	navigate(WTKeyedMap c, Transition transition, boolean successor) Navigates the PhaseTemplate->PhaseSuccession using param transition.
LifeCycleManaged	promote(LifeCycleManaged object, LifeCycleSignature signature) Move the object to the next phase.
LifeCycleManaged	reassign(LifeCycleManaged object, LifeCycleTemplateReference lctRef) Reassign a life cycle managed object to a new life cycle.
LifeCycleManaged	reassign(LifeCycleManaged object, LifeCycleTemplateReference lctRef, WTContainerRef context) Reassign a life cycle managed object to a new life cycle in a certain WTContainerRef.
WTList	reassign(WTList list, LifeCycleTemplateReference lctRef, WTContainerRef context, boolean preserveState) Reassign all objects in a WTList to a lifecycle.
WTList	reassign(WTList list, LifeCycleTemplateReference lctRef, WTContainerRef context, State state) Reassign the life cycle managed objects in a WTList to a new life cycle in a certain WTContainerRef.
Vector	saveCriteria(LifeCycleManaged object, Vector criteria) Deprecated. at R5.0
TransactionResult	saveLifeCycleTemplate(TransactionContainer aTran) Store or update a LifeCycleTemplate.
TransactionResult	saveLifeCycleTemplate(TransactionContainer aTran, WTContainerRef context) Store or update a LifeCycleTemplate.
TransactionResult	saveLifeCycleTemplate(TransactionContainer aTran, WTContainerRef context, boolean bypassDefaultTransitions) Store or update a LifeCycleTemplate.
State[]	selectableStates() Deprecated. in R4.0. Use the appropriate call on the EnumeratedType object to get these values.
void	setEnabled(LifeCycleTemplate aTemplate, boolean enable) Enable/Disable the Life Cycle Template Master Supported API: true
void	setEnabled(LifeCycleTemplateMaster aMaster, boolean enable) Enable/Disable the Life Cycle Template Master Supported API: true
LifeCycleManaged	setLifeCycleState(LifeCycleManaged object, State state) Set the state of the Life Cycle Managed object.
LifeCycleManaged	setLifeCycleState(LifeCycleManaged object, State state, boolean terminAssocRunningProcesses) Set the state of the Life Cycle Managed object and provide the option to terminate the associated workflows.
LifeCycleManaged	setLifeCycleState(LifeCycleManaged object, State state, boolean terminAssocRunningProcesses, Timestamp timestamp) Set the state of the Life Cycle Managed object.
WTList	setLifeCycleState(WTList list, Map stateMap, WTList terminateList) Set the state of the Life Cycle Managed objects in the WTList list.
WTList	setLifeCycleState(WTList list, State state, boolean terminAssocRunningProcesses) Set the state of the Life Cycle Managed objects and provide the option to terminate the associated workflows.
void	setRouting(LifeCycleTemplate aTemplate, boolean routing) Set/reset the rouing attribute on the Life Cycle Template Master.
void	setRouting(LifeCycleTemplateMaster aMaster, boolean routing) Set/reset the routing attribute of the Life Cycle Template Master.
LifeCycleManaged	submitForApproval(LifeCycleManaged object) Submit the object for review.
LifeCycleManaged	validateSubmitForApproval(LifeCycleManaged object) Perform pre-submit validations Supported API: true
LifeCycleSignature	vote(LifeCycleManaged object, LifeCycleSignature signature) Record a signer disposition (Yes/No) and any comments.

Method Detail

submitForApproval

public LifeCycleManaged submitForApproval(LifeCycleManaged object)
                                   throws WTException,
                                          LifeCycleException

Submit the object for review.

Supported API: true

Parameters:

object - the LifeCycleManaged object that should be submitted for approval

Returns:

LifeCycleManaged

Throws:

WTException

LifeCycleException

vote

public LifeCycleSignature vote(LifeCycleManaged object,
                               LifeCycleSignature signature)
                        throws WTException,
                               LifeCycleException

Record a signer disposition (Yes/No) and any comments.

Supported API: true

Parameters:

object - the LifeCycleManaged object that should be voted on

signature - the signature object where the vote results should be recorded

Returns:

LifeCycleSignature

Throws:

WTException

LifeCycleException

promote

public LifeCycleManaged promote(LifeCycleManaged object,
                                LifeCycleSignature signature)
                         throws WTException,
                                LifeCycleException

Move the object to the next phase.

The doPromote method is executed

Supported API: true

Parameters:

object - the LifeCycleManaged object that should be promoted

signature - the Signature object where the results and information about the promote should be recorded

Returns:

LifeCycleManaged

Throws:

WTException

LifeCycleException

demote

public LifeCycleManaged demote(LifeCycleManaged object,
                               LifeCycleSignature signature)
                        throws WTException,
                               LifeCycleException

Move the object to the previous phase.

The doDemote method is executed

Supported API: true

Parameters:

object - the LifeCycleManaged object that should be demoted.

signature - the Signature object where the results and information about the demote should be recorded

Returns:

LifeCycleManaged

Throws:

WTException

LifeCycleException

deny

public LifeCycleManaged deny(LifeCycleManaged object,
                             LifeCycleSignature signature)
                      throws WTException,
                             LifeCycleException

Remove the object from the gate and return the object to the submitter

Supported API: true

Parameters:

object - the LifeCycleManaged object that should be denied

signature - the Signature object that the result and information about the deny is recorded

Returns:

LifeCycleManaged

Throws:

WTException

LifeCycleException

drop

public LifeCycleManaged drop(LifeCycleManaged object,
                             LifeCycleSignature signature)
                      throws WTException,
                             LifeCycleException

Transition the object to an end state

Supported API: true

Parameters:

object - the LifeCycleManaged object that should be moved to a final/dropped state

signature - the LifeCycleSignature object records information about the drop process

Returns:

LifeCycleManaged

Throws:

WTException

LifeCycleException

reassign

public LifeCycleManaged reassign(LifeCycleManaged object,
                                 LifeCycleTemplateReference lctRef)
                          throws WTException,
                                 LifeCycleException

Reassign a life cycle managed object to a new life cycle.

Supported API: true

Parameters:

object - the LifeCycleManaged object that should be assigned to a new life cycle

lctRef - a reference to a LifeCycleTemplate, the LifeCycleTemplate that the object should be reassigned to

Returns:

LifeCycleManaged

Throws:

WTException

LifeCycleException

getLifeCycleTemplate

public LifeCycleTemplate getLifeCycleTemplate(LifeCycleManaged object)
                                       throws WTException,
                                              LifeCycleException

Deprecated. in R4.0 - Use myObject.getLifeCycleTemplate() instead.

Answer the LifeCycleTemplate the object is assigned to

Supported API: true

Parameters:

object - the LifeCycleManaged object used as search criteria in the retrieval of the LifeCycleTemplate

Returns:

LifeCycleTemplate

Throws:

WTException

LifeCycleException

getSignatures

public Vector getSignatures(LifeCycleManaged object,
                            WTUser user,
                            Role role)
                     throws WTException,
                            LifeCycleException

Answer a vector of LifeCycleSignature for the current phase based on object, user and role.

Supported API: true

Parameters:

object - the LifeCycleManaged object used as search criteria in the retrieval of signature objects

user - the WTUser object used as search criteria in the retrieval of Signature objects

role - the Role object used as search criteria in the retrieval of the Signature objects

Returns:

Vector

Throws:

WTException

LifeCycleException

getSignatures

public Vector getSignatures(LifeCycleManaged object,
                            Role role)
                     throws WTException,
                            LifeCycleException

Answer a vector of LifeCycleSignature for the current phase based on object and role.

Supported API: true

Parameters:

object - the LifeCycleManaged object used as search criteria in the retrieval of the Signature objects

role - the Role object used as search criteria in the retrieval of Signature objects

Returns:

Vector

Throws:

WTException

LifeCycleException

getSignatures

public Vector getSignatures(LifeCycleManaged object)
                     throws WTException,
                            LifeCycleException

Answer a vector of signatures for all roles for the object for the current phase.

Supported API: true

Parameters:

object - the LifeCycleManaged object used as search criteria in the retrieval of Signature objects

Returns:

Vector

Throws:

WTException

LifeCycleException

getSignatures

public Vector getSignatures(LifeCycleManaged object,
                            WTUser user)
                     throws WTException,
                            LifeCycleException

Answer a vector of LifeCycleSignatures based on supplied object & user.

Supported API: true

Parameters:

object - The LifeCycleManaged object used as search criteria in the retrieval of Signature objects

user - the WTUser object used as search criteria in the retrieval of Signature objects

Returns:

Vector

Throws:

WTException

LifeCycleException

getAllSignatures

public Vector getAllSignatures(LifeCycleManaged object)
                        throws WTException,
                               LifeCycleException

Answer a vector of signatures for all roles for the object for the current phase and all preceeding phases.

Supported API: true

Parameters:

object - the LifeCycleManaged object used as search criteria in the retrieval of Signature objects

Returns:

Vector

Throws:

WTException

LifeCycleException

createLifeCycleSignature

public LifeCycleSignature createLifeCycleSignature(Persistable object,
                                                   WTPrincipal signer,
                                                   String comments,
                                                   Role role,
                                                   boolean vote)
                                            throws WTException

Answer an initialized but unpersisted LifeCycleSignature instance

Supported API: true

Parameters:

object - the Persistable object that the LifeCycleSignature is associated to

signer - the WTPrincipal who did the work

comments - any comments the signer recorded about the work accomplished

role - the Role object, used to represent the role the signer was participating as

vote - a boolean signer designation, used to record the disposition

Returns:

LifeCycleSignature

Throws:

WTException

getReviewerList

public Vector getReviewerList(LifeCycleManaged object)
                       throws WTException,
                              LifeCycleException

Answer a vector of LifeCycleSignatures

Supported API: true

Parameters:

object - The LifeCycleManaged object used as search criteria in the retrieval of Signature objects

Returns:

Vector

Throws:

WTException

LifeCycleException

getAllReviewerList

public Vector getAllReviewerList(LifeCycleManaged object)
                          throws WTException,
                                 LifeCycleException

Answer a vector of LifeCycleSignatures

Supported API: true

Parameters:

object - The LifeCycleManaged object used as search criteria in the retrieval of Signature objects

Returns:

Vector

Throws:

WTException

LifeCycleException

getRoles

public Vector getRoles(LifeCycleManaged object)
                throws WTException,
                       LifeCycleException

Answer a vector of strings - role names for the current phase

Supported API: true

Parameters:

object - the LifeCycleManaged object used as search criteria in the retrieval of Role objects

Returns:

Vector

Throws:

WTException

LifeCycleException

getCriteria

public Vector getCriteria(LifeCycleManaged object)
                   throws WTException,
                          LifeCycleException

Answer a vector of Criterion objects for the current phase

Supported API: true

Parameters:

object - the LifeCycleManaged object used as search criteria in the retrieval of Criterion objects

Returns:

Vector

Throws:

WTException

LifeCycleException

saveLifeCycleTemplate

public TransactionResult saveLifeCycleTemplate(TransactionContainer aTran)
                                        throws WTException,
                                               LifeCycleException

Store or update a LifeCycleTemplate. This method accepts and processes a batch container of persistence assertions.

Supported API: true

Parameters:

aTran - a TransactionContainer that contains a set of LifeCycleTemplate, PhaseTemplate, AdHocAclSpec, Criterion and Transition assertions that need to be applied against one or more LifeCycleTemplate objects

Returns:

TransactionResult

Throws:

WTException

LifeCycleException

saveCriteria

public Vector saveCriteria(LifeCycleManaged object,
                           Vector criteria)
                    throws WTException,
                           LifeCycleException

Deprecated. at R5.0

Save/Update a vector of Criterion objects

Supported API: false

Parameters:

object - the LifeCycleManged object that the associated criteria should be applied to

criteria - a Vector of Criterion objects that should be applied to the LifeCycleManaged object

Returns:

Vector

Throws:

WTException

LifeCycleException

allStates

public State[] allStates()
                  throws WTException

Deprecated. in R4.0. Use the appropriate call on the EnumeratedType object to get these values.

Answer an array of State objects

Supported API: false

Returns:

State[]

Throws:

WTException

selectableStates

public State[] selectableStates()
                         throws WTException

Deprecated. in R4.0. Use the appropriate call on the EnumeratedType object to get these values.

Answer an array of State objects declared selectable

Supported API: false

Returns:

State[]

Throws:

WTException

getHistory

public QueryResult getHistory(LifeCycleManaged object)
                       throws WTException,
                              LifeCycleException

Answer an enumeration of LifeCycleHistory objects based on supplied object.

Usage:

LifeCycleHistory aHistory = null; Enumeration e = LifeCycleHelper.service.getHistory(aLifeCycleManaged); while (e.hasMoreElements()) { aHistory = (LifeCycleHistory)e.nextElement(); // -- do stuff }

Supported API: true

Parameters:

object - the LifeCycleManaged object used as search criteria for the retrieval of History information

Returns:

QueryResult

Throws:

WTException

LifeCycleException

getCurrentPhase

public Phase getCurrentPhase(LifeCycleManaged object)
                      throws WTException

Deprecated. at R4.0 - This method should not be used outside of the Life Cycle service. This phase object should be considered private to LifeCycle. If you have a need to access information on this object, please send a detailed request via Windchill Technical Marketing.

Answer the object's current phase

Supported API: false

Parameters:

object - the LifeCycleManaged object used as search criteria in the retrieval of the current phase object

Returns:

Phase

Throws:

WTException

isA

public boolean isA(LifeCycleManaged object,
                   WTUser user,
                   Role role)
            throws WTException,
                   LifeCycleException

Deprecated. at 8.0. A user no longer has to belong to a specific role in order to complete a lifecycle task

Answer whether the designated user is validated for the designated role

Supported API: true

Parameters:

object - the LifeCycleManaged object

user - the designated user

role - the designated role

Returns:

boolean

Throws:

WTException

LifeCycleException

isInInitialPhase

public boolean isInInitialPhase(LifeCycleManaged object)
                         throws WTException

Answer whether the LifeCycleManaged object is in the Initial phase

Supported API: true

Parameters:

object - The LifeCycleManaged object

Returns:

boolean

Throws:

WTException

isInFinalPhase

public boolean isInFinalPhase(LifeCycleManaged object)
                       throws WTException

Answers whether the LifeCycleManaged object is in the Final phase of its LifeCycle

Supported API: true

Parameters:

object - The LifeCycleManaged object

Returns:

boolean

Throws:

WTException

getLifeCycleTemplate

public LifeCycleTemplate getLifeCycleTemplate(String aTemplateName)
                                       throws LifeCycleException,
                                              WTException

Given a String representation of the LifeCycleTemplate name, answer the LifeCycleTemplate. If no template is found, return null/code>.

Supported API: true

Parameters:

aTemplateName - the name of the LifeCycleTemplate to retrieve

Returns:

LifeCycleTemplate

Throws:

LifeCycleException

WTException

validateSubmitForApproval

public LifeCycleManaged validateSubmitForApproval(LifeCycleManaged object)
                                           throws WTException,
                                                  LifeCycleException

Perform pre-submit validations

Supported API: true

Parameters:

object - the LifeCycleManaged object to be submitted

Returns:

LifeCycleManaged

Throws:

WTException

LifeCycleException

hasAugmentRoleAccess

public boolean hasAugmentRoleAccess(Role role,
                                    LifeCycleManaged object)
                             throws WTException,
                                    LifeCycleException

Given a role and a LifeCycleManaged object, determines whether the current user has the permissions required to update the role participants

Supported API: true

Parameters:

role - The LifeCycleManaged object that the role/participant mapping is being added to

object - the object whose team is being modified

Returns:

boolean

Throws:

WTException

LifeCycleException

findCandidateTemplates

public Vector findCandidateTemplates(LifeCycleManaged object)
                              throws WTException,
                                     LifeCycleException

Answer a vector of enabled life cycle template references valid for the life cycle managed object findCandidateMasterReference is the preferable to use instead of this method. Using findCandidateMasterReference plus the 'getLifeCycleTemplate' method on that object will get the latest iteration at the last possible moment, eliminating some multi-user timing issues.

Supported API: true

Parameters:

object - the LifeCycleManaged object used as search criteria in the retrieval of canidate LifeCycleTemplates

Returns:

Vector

Throws:

WTException

LifeCycleException

findCandidateTemplates

public Vector findCandidateTemplates(Class targetClass)
                              throws WTException,
                                     LifeCycleException

Answer a vector of enabled life cycle template references valid for the class findCandidateMasterReference is the preferable to use instead of this method. Using findCandidateMasterReference plus the 'getLifeCycleTemplate' method on that object will get the latest iteration at the last possible moment, eliminating some multi-user timing issues.

Supported API: true

Parameters:

targetClass - the class used as search criteria in the retrieval of canidate LifeCycleTemplates

Returns:

Vector

Throws:

WTException

LifeCycleException

findStates

public Vector findStates(LifeCycleTemplate aLifeCycleTemplate)
                  throws WTException,
                         LifeCycleException

Given a particular LifeCycleTemplate, answer a Vector of all the Life Cycle States used in that LifeCycle

Supported API: true

Parameters:

aLifeCycleTemplate - the LifeCycleTemplate used to retrieve the appropriate states

Returns:

Vector

Throws:

WTException

LifeCycleException

isState

public boolean isState(LifeCycleTemplate aLifeCycleTemplate,
                       State aState)
                throws WTException,
                       LifeCycleException

Given a particular LifeCycleTemplate and a State, answer whether or not the State is used in the LifeCycle

Supported API: true

Parameters:

aLifeCycleTemplate - the LifeCycleTemplate used in the lookup

aState - the State used in the lookup

Returns:

boolean

Throws:

WTException

LifeCycleException

findPredecessorStates

public Enumeration findPredecessorStates(LifeCycleManaged object)
                                  throws WTException,
                                         LifeCycleException

Given a particular LifeCycleManged object, answer an enumeration of all the predecessor States

Supported API: true

Parameters:

object - the LifeCycleManaged object of interest

Returns:

Enumeration

Throws:

WTException

LifeCycleException

findSuccessorStates

public Enumeration findSuccessorStates(LifeCycleManaged object)
                                throws WTException,
                                       LifeCycleException

Given a particular LifeCycleTemplate, answer an enumeration of all the Successor States

Supported API: true

Parameters:

object - the LifeCycleManaged object of interest

Returns:

Enumeration

Throws:

WTException

LifeCycleException

setEnabled

public void setEnabled(LifeCycleTemplate aTemplate,
                       boolean enable)
                throws WTException,
                       LifeCycleException

Enable/Disable the Life Cycle Template Master

Supported API: true

Parameters:

aTemplate - the template to set the enabled flat on

enable - specifies whether or not the template is enabled

Throws:

WTException

LifeCycleException

setEnabled

public void setEnabled(LifeCycleTemplateMaster aMaster,
                       boolean enable)
                throws WTException,
                       LifeCycleException

Enable/Disable the Life Cycle Template Master

Supported API: true

Parameters:

aMaster - the lifecycle template master to set the enabled flag on

enable - sets the value of the enabled flag to true or false

Throws:

WTException

LifeCycleException

findCandidateMasterReferences

public Vector findCandidateMasterReferences(LifeCycleManaged object)
                                     throws WTException,
                                            LifeCycleException

Answer a vector of life cycle template references valid for the life cycle managed object

Supported API: true

Parameters:

object - the LifeCycleManaged object used as search criteria in the retrieval of canidate LifeCycleTemplates

Returns:

Vector

Throws:

WTException

LifeCycleException

findCandidateMasterReferences

public Vector findCandidateMasterReferences(Class targetClass)
                                     throws WTException,
                                            LifeCycleException

Answer a vector of life cycle template references valid for the class

Supported API: true

Parameters:

targetClass - the class used as search criteria in the retrieval of canidate LifeCycleTemplates

Returns:

Vector

Throws:

WTException

LifeCycleException

getLifeCycleTemplateMaster

public LifeCycleTemplateMaster getLifeCycleTemplateMaster(String aMasterName)
                                                   throws LifeCycleException,
                                                          WTException

Given a String representation of the LifeCycleTemplateMaster name, answer the LifeCycleTemplateMasterReference

Supported API: true

Parameters:

aMasterName - the name of the LifeCycleTemplate to retrieve

Returns:

LifeCycleTemplateMaster

Throws:

LifeCycleException

WTException

getLifeCycleTemplateReference

public LifeCycleTemplateReference getLifeCycleTemplateReference(String aName)
                                                         throws LifeCycleException,
                                                                WTException

Given a String representation of the LifeCycleTemplater name, find the latest iteration or working copy of the LifeCycleTemplate. Return a LifeCycleTemplateReference.

Supported API: true

Parameters:

aName - the name of the LifeCycleTemplate to retrieve

Returns:

LifeCycleTemplateReference

Throws:

LifeCycleException

WTException

setLifeCycleState

public LifeCycleManaged setLifeCycleState(LifeCycleManaged object,
                                          State state,
                                          boolean terminAssocRunningProcesses)
                                   throws WTException,
                                          LifeCycleException

Set the state of the Life Cycle Managed object and provide the option to terminate the associated workflows. If null is passed as the WfState, all processes are terminated.

Supported API: true

Parameters:

object - The LifeCycleManaged object whose state should be updated

state - The state to set the LifeCycleManaged object to.

terminAssocRunningProcesses - a flag that determines whether or not to terminate the wf processes associated with this phase that are OPEN_RUNNING

Returns:

LifeCycleManaged

Throws:

WTException

LifeCycleException

setLifeCycleState

public LifeCycleManaged setLifeCycleState(LifeCycleManaged object,
                                          State state)
                                   throws WTException,
                                          LifeCycleException

Set the state of the Life Cycle Managed object.

Supported API: true

Parameters:

object - The LifeCycleManaged object whose state should be updated

state - The state to set the LifeCycleManaged object to.

Returns:

LifeCycleManaged

Throws:

WTException

LifeCycleException

findAssociatedProcesses

public Vector findAssociatedProcesses(LifeCycleManaged object,
                                      WfState state)
                               throws WTException,
                                      LifeCycleException

Given a Life Cycle Managed object, return the Workflow processes associated with the current phase. If null is specified as the Wf State, all processes are retrieved.

Supported API: true

Parameters:

object - the Life Cycle Managed object

state - the Workflow state

Returns:

Vector

Throws:

WTException

LifeCycleException

findExportImportFileNames

public Vector findExportImportFileNames()
                                 throws WTException,
                                        LifeCycleException

Retrieve a vector of file names from the Import/Export directory

Supported API: true

Returns:

Vector

Throws:

WTException

LifeCycleException

exportTemplates

public void exportTemplates(Vector lifeCycleVector,
                            String fileName,
                            boolean appendFlag)
                     throws WTException,
                            LifeCycleException

Populate a file with the xml equivalent of the LifeCycleTemplate objects. The xml file is zipped in a jar or zip file.

Supported API: true

Parameters:

lifeCycleVector - an enumeration of LifeCycleTemplate objects that need to be exported

fileName - the name of the file that the csv version of the templates should be written to (not including the .csv suffix or the directory name)

appendFlag - a flag that determines whether the exported data should overwrite any existing data or append it to the end

Throws:

WTException

LifeCycleException

importTemplates

public void importTemplates(String fileName)
                     throws WTException,
                            LifeCycleException

Given a WTContainerRef and a jar or zip file that contains a version of any number of LifeCycleTemplate objects, import these objects.

Supported API: true

Parameters:

fileName - the name of the file that the xml version of the templates should be imported from (not including the .csv extension or the directory name)

Throws:

WTException

LifeCycleException

copyTemplate

public LifeCycleTemplate copyTemplate(LifeCycleTemplate lifeCycleTemplate,
                                      String copyName,
                                      String folderLocation)
                               throws WTException,
                                      LifeCycleException

Produces a copy of the LifeCycleTemplate object and persists it with the name passed as argument. If the name argument is "null", the name of the copied LifeCycleTemplate object is prefixed with 'copy of'. If the folder location is not specified, the object will be persisted in the orginal LifeCycleTemplates's folder location. Note: The 'Copy Of' prefix is pulled from a Resource Bundle for localization purposes.

Supported API: true

Parameters:

lifeCycleTemplate - the LifeCycleTemplate object that should be copied

copyName - the name of the new LifeCycleTemplate

folderLocation - the folder location of the new LifeCycleTemplate

Returns:

LifeCycleTemplate

Throws:

WTException

LifeCycleException

findAllTemplates

public Vector findAllTemplates()
                        throws WTException,
                               LifeCycleException

Answer a vector of all life cycle templates. The latest iteration of each life cycle template will be returned. In this particular context, the definition of 'latest iteration' is either the current user's working copy, if one exists, or the latest iteration in the vault.

Supported API: true

Returns:

Vector

Throws:

WTException

LifeCycleException

getLatestIteration

public LifeCycleTemplate getLatestIteration(LifeCycleTemplateMaster master)
                                     throws WTException,
                                            LifeCycleException

Given a LifeCycleTemplateMaster, return the latest iteration (LifeCycleTemplate)

Supported API: true

Parameters:

master - the lifecycle master of interest

Returns:

LifeCycleTemplate

Throws:

WTException

LifeCycleException

getLatestIteration

public LifeCycleTemplateReference getLatestIteration(LifeCycleTemplateMasterReference master)
                                              throws WTException,
                                                     LifeCycleException

Given a LifeCycleTemplateMasterReference, return the latest iteration (LifeCycleTemplateReference)

Supported API: true

Parameters:

master - the lifecycle template master of interest

Returns:

LifeCycleTemplateReference

Throws:

WTException

LifeCycleException

getPhaseTemplates

public Vector getPhaseTemplates(LifeCycleTemplate template)
                         throws WTException,
                                LifeCycleException

Given a LifeCycleTemplate, return a vector of all the PhaseTemplate objects

Supported API: true

Parameters:

template - the lifecycle template to retrieve the phase templates for

Returns:

Vector

Throws:

WTException

LifeCycleException

getCurrentWorkflow

public ObjectReference getCurrentWorkflow(LifeCycleManaged object)
                                   throws WTException,
                                          LifeCycleException

Given a LifeCycleManaged object, return a reference to the current WfProcess. If the LifeCycleManaged object is in the phase, the Phase WF is returned. If the LifeCycleManaged object is at the gate, the Gate WF is returned. If there is no workflow, a null is returned.

Supported API: true

Parameters:

object - the object whoose current workflow should be returned

Returns:

ObjectReference

Throws:

WTException

LifeCycleException

getStateLink

public String getStateLink(LifeCycleManaged object)
                    throws WTException,
                           LifeCycleException

Deprecated. at 5.0

Given a LifeCycleManaged object, return the current state of the object as a link to the WfProcess (ProcessManager)

Supported API: false

Parameters:

object - the object to build the statesLink for.

Returns:

String

Throws:

WTException

LifeCycleException

augmentRoles

public Phase augmentRoles(LifeCycleManaged object)
                   throws WTException,
                          LifeCycleException

Given a LifeCycleManaged object, the current State of the Object and the RoleHolder (the phase object), change the role participants to reflect those in the RoleHolder2

Supported API: true

Parameters:

object - The LifeCycleManaged object that the role/participant mapping is being added to

Returns:

Phase

Throws:

WTException

LifeCycleException

getSuccessorState

public State getSuccessorState(LifeCycleManaged lcmObject)
                        throws WTException,
                               LifeCycleException

This operation determines the current state of the object and returns the successor state for the object. That is, the state the object will be in when promoted.

Supported API: true

Parameters:

lcmObject - The Life Cycle Managed object used to get the next state.

Returns:

State

Throws:

WTException

LifeCycleException

getPredecessorState

public State getPredecessorState(LifeCycleManaged lcmObject)
                          throws WTException,
                                 LifeCycleException

This operation determines the current state of the object and returns the predecessor state for the object. That is, the state the object will be in when demoted

Supported API: true

Parameters:

lcmObject - The Life Cycle Managed object used to get the next state.

Returns:

State

Throws:

WTException

LifeCycleException

canCreateLifeCycleTemplate

public boolean canCreateLifeCycleTemplate(WTUser user)
                                   throws WTException

Determines if a given user is entitled to create a Life Cycle Templates. Returns 'true' if the user is an Org Administrator or an Exhange Administrator.

Supported API: false

Parameters:

user - the user to test for lifecycle creation validation

Returns:

boolean

Throws:

WTException

augmentRoles

public void augmentRoles(Team team)
                  throws WTException,
                         LifeCycleException

Given a team, rebuild all the ad hoc acls for objects associated with the team.

Supported API: true

Parameters:

team - The team being updated.

Throws:

WTException

LifeCycleException

getLifeCycleTemplate

public LifeCycleTemplate getLifeCycleTemplate(String aTemplateName,
                                              WTContainerRef context)
                                       throws LifeCycleException,
                                              WTException

Given a String representation of the LifeCycleTemplate name and a WTContainerRef, answer the LifeCycleTemplate. If no template is found, return null/code>.

Supported API: true

Parameters:

aTemplateName - the name of the LifeCycleTemplate to retrieve

context - the container to search for the lifecycle template

Returns:

LifeCycleTemplate

Throws:

LifeCycleException

WTException

getLifeCycleTemplateReference

public LifeCycleTemplateReference getLifeCycleTemplateReference(String aName,
                                                                WTContainerRef context)
                                                         throws LifeCycleException,
                                                                WTException

Given a String representation of the LifeCycleTemplater name and a WTContainerRef, find the latest iteration or working copy of the LifeCycleTemplate. Return a LifeCycleTemplateReference.

Supported API: true

Parameters:

aName - the name of the LifeCycleTemplate to retrieve

context - the container to search for the lifecycle template master

Returns:

LifeCycleTemplateReference

Throws:

LifeCycleException

WTException

findAllTemplates

public Vector findAllTemplates(WTContainerRef context)
                        throws WTException,
                               LifeCycleException

Answer a vector of all life cycle templates for the WTContainerRef passed. The latest iteration of each life cycle template will be returned. In this particular context, the definition of 'latest iteration' is either the current user's working copy, if one exists, or the latest iteration in the vault.

Supported API: true

Parameters:

context - the container to search for lifecycle templates

Returns:

Vector

Throws:

WTException

LifeCycleException

getLifeCycleTemplateMaster

public LifeCycleTemplateMaster getLifeCycleTemplateMaster(String aMasterName,
                                                          WTContainerRef context)
                                                   throws LifeCycleException,
                                                          WTException

Given a String representation of the LifeCycleTemplateMaster name and a WTContainerRef, answer the LifeCycleTemplateMasterReference

Supported API: true

Parameters:

aMasterName - the name of the LifeCycleTemplate to retrieve

context - the container to search for the lifecycle template master

Returns:

LifeCycleTemplateMaster

Throws:

LifeCycleException

WTException

importTemplates

public void importTemplates(String fileName,
                            WTContainerRef context)
                     throws WTException,
                            LifeCycleException

Given a WTContainerRef and a jar or zip file that contains a version of any number of LifeCycleTemplate objects, import these objects.

Supported API: true

Parameters:

fileName - the name of the jar or zip file that the xml version of the templates should be imported from

context - the container to import the lifecycle template into

Throws:

WTException

LifeCycleException

reassign

public LifeCycleManaged reassign(LifeCycleManaged object,
                                 LifeCycleTemplateReference lctRef,
                                 WTContainerRef context)
                          throws WTException,
                                 LifeCycleException

Reassign a life cycle managed object to a new life cycle in a certain WTContainerRef.

Supported API: true

Parameters:

object - the LifeCycleManaged object that should be assigned to a new life cycle

lctRef - a reference to a LifeCycleTemplate, the LifeCycleTemplate that the object should be reassigned to

context - the container where the objects associated workflow processes will be created

Returns:

LifeCycleManaged

Throws:

WTException

LifeCycleException

saveLifeCycleTemplate

public TransactionResult saveLifeCycleTemplate(TransactionContainer aTran,
                                               WTContainerRef context)
                                        throws WTException,
                                               LifeCycleException

Store or update a LifeCycleTemplate. This method accepts and processes a batch container of persistence assertions. If a WTContainerRef is passed, and it is different that that of this templates master; then a new master is created in the passed WTContainer, and this template becomes the first iteration.

Supported API: true

Parameters:

aTran - a TransactionContainer that contains a set of LifeCycleTemplate, PhaseTemplate, AdHocAclSpec, Criterion and Transition assertions that need to be applied against one or more LifeCycleTemplate objects

context - the container the lifecycle template is being saved in

Returns:

TransactionResult

Throws:

WTException

LifeCycleException

findCandidateMasterReferences

public Vector findCandidateMasterReferences(Class targetClass,
                                            WTContainerRef context)
                                     throws WTException,
                                            LifeCycleException

Answer a vector of life cycle template references valid for the target class in the container.

Supported API: true

Parameters:

targetClass - the class used as search criteria in the retrieval of canidate LifeCycleTemplates

context - the container to search for lifecycle template masters

Returns:

Vector

Throws:

WTException

LifeCycleException

findAllTemplateMasters

public QueryResult findAllTemplateMasters(WTContainerRef context)
                                   throws WTException,
                                          LifeCycleException

Answer a vector of all life cycle template masters for the WTContainerRef passed. The latest iteration of each life cycle template will be returned. In this particular context, the definition of 'latest iteration' is either the current user's working copy, if one exists, or the latest iteration in the vault.

Supported API: true

Parameters:

context - the container to search for lifecycle templates

Returns:

QueryResult

Throws:

WTException

LifeCycleException

setRouting

public void setRouting(LifeCycleTemplate aTemplate,
                       boolean routing)
                throws WTException,
                       LifeCycleException

Set/reset the rouing attribute on the Life Cycle Template Master. This attribute denotes whether or not the template master can be used to route other objects

Supported API: true

Parameters:

aTemplate - the template to set the routing statis on

routing - sets the routing flag to true or false

Throws:

WTException

LifeCycleException

setRouting

public void setRouting(LifeCycleTemplateMaster aMaster,
                       boolean routing)
                throws WTException,
                       LifeCycleException

Set/reset the routing attribute of the Life Cycle Template Master. This attribute denotes whether or not the template master can be used to route other objects

Supported API: true

Parameters:

aMaster - the lifecycle template master to set the routing status on

routing - sets the routing flag to true or false

Throws:

WTException

LifeCycleException

findRoutingTemplates

public Vector findRoutingTemplates(WTContainerRef context)
                            throws WTException,
                                   LifeCycleException

Return an Enumeration of all lifecycle templates for the WTContainerRef passed. The latest iteration of each life cycle template will be returned. In this particular context, the definition of 'latest iteration' is either the current user's working copy, if one exists, or the latest iteration in the vault.

Supported API: true

Parameters:

context - the container to search for lifecycle templates

Returns:

Vector

Throws:

WTException

LifeCycleException

findAllTemplates

public Vector findAllTemplates(WTContainerRef context,
                               boolean routingOnly)
                        throws WTException,
                               LifeCycleException

Answer a vector of all life cycle templates for the WTContainerRef passed. If routingOnly is true, returns only those templates whose routing attribute is true. The latest iteration of each life cycle template will be returned. In this particular context, the definition of 'latest iteration' is either the current user's working copy, if one exists, or the latest iteration in the vault.

Supported API: true

Parameters:

context - the container to search for lifecycle templates

routingOnly - specifies whether only the lifecycle templates marked as routing should be returned or it all enabled lifecycle templates should be returned

Returns:

Vector

Throws:

WTException

LifeCycleException

canCreateLifeCycleTemplate

public boolean canCreateLifeCycleTemplate(WTUser user,
                                          WTContainerRef context)
                                   throws WTException

Determines if a given user is entitled to create a Life Cycle Templates in the given container. Returns 'true' if the user is an Org Administrator or an Exhange Administrator.

Supported API: false

Parameters:

user - the user to validate creation privileges against

context - the container to validate access against

Returns:

boolean

Throws:

WTException

copyTemplate

public LifeCycleTemplate copyTemplate(LifeCycleTemplate lifeCycleTemplate,
                                      String copyName,
                                      String folderLocation,
                                      WTContainerRef context)
                               throws WTException,
                                      LifeCycleException

Produces a copy of the LifeCycleTemplate object and persists it with the name passed as argument. If the name argument is "null", the name of the copied LifeCycleTemplate object is prefixed with 'copy of'. If the folder location is not specified, the object will be persisted in the orginal LifeCycleTemplates's folder location. If the context is null, the current container will be used. Note: The 'Copy Of' prefix is pulled from a Resource Bundle for localization purposes.

Supported API: true

Parameters:

lifeCycleTemplate - the LifeCycleTemplate object that should be copied

copyName - the name of the new LifeCycleTemplate

folderLocation - the folder location of the new LifeCycleTemplate

context - the container where the copy should be stored

Returns:

LifeCycleTemplate

Throws:

WTException

LifeCycleException

navigate

public Set navigate(LifeCycleManaged lcmObject,
                    Transition name,
                    boolean successor)
             throws WTException

Navigate the transition of the current state of the LifeCycleManagedObject using the passed transition. Return a set of States

Supported API: true

Parameters:

lcmObject - LifeCycleManagedObject

name - Transition to navigate

successor - get Successors

Returns:

Set

Throws:

WTException

reassign

public WTList reassign(WTList list,
                       LifeCycleTemplateReference lctRef,
                       WTContainerRef context,
                       boolean preserveState)
                throws WTException,
                       LifeCycleException

Reassign all objects in a WTList to a lifecycle.

Supported API: true

Parameters:

list - the WtList of LifeCycleManaged objects that should be assigned to a new life cycle

lctRef - a reference to a LifeCycleTemplate, the LifeCycleTemplate that the object should be reassigned to

context - The container the object resides in. This may be null.

preserveState - If this is set to true, the existing state of objects will be preserved if the state is contained in the lifecycle template. Otherwise, the object will be set to the initial state of the lifecycle.

Returns:

WTList

Throws:

WTException

LifeCycleException

reassign

public WTList reassign(WTList list,
                       LifeCycleTemplateReference lctRef,
                       WTContainerRef context,
                       State state)
                throws WTException,
                       LifeCycleException

Reassign the life cycle managed objects in a WTList to a new life cycle in a certain WTContainerRef.

Supported API: true

Parameters:

list - the WTList of LifeCycleManaged objects that should be assigned to a new life cycle

lctRef - a reference to a LifeCycleTemplate, the LifeCycleTemplate that the object should be reassigned to

context - The container which the object resides in.

state - The state the objects in the lifecycle should be assigned when reassigned to the lifecycle.

Returns:

WTList

Throws:

WTException

LifeCycleException

setLifeCycleState

public WTList setLifeCycleState(WTList list,
                                State state,
                                boolean terminAssocRunningProcesses)
                         throws WTException,
                                LifeCycleException

Set the state of the Life Cycle Managed objects and provide the option to terminate the associated workflows. If null is passed as the WfState, all processes are terminated.

Supported API: true

Parameters:

list - The LifeCycleManaged objects whose state should be updated

state - The state to set the LifeCycleManaged object to.

terminAssocRunningProcesses - a flag that determines whether or not to terminate the wf processes associated with this phase that are OPEN_RUNNING

Returns:

WTList

Throws:

WTException

LifeCycleException

navigate

public Set navigate(LifeCycleTemplateReference lctRef,
                    State state,
                    Transition transition,
                    boolean successor)
             throws WTException

Navigate the transition from the passed state using the passed transition. Return a set of States

Supported API: true

Parameters:

lctRef - reference to the LifeCycleTemplate.

state - State of the LifeCycleTemplate.

transition - Transtion to navigate

successor - get Successors

Returns:

Set

Throws:

WTException

findSetStateCandidates

public WTKeyedMap findSetStateCandidates(WTCollection lcms)
                                  throws WTException

Determines the allowable states the session principal can set the objects in the collection to. The return type is a map with the lifecycle managed objects assigned as keys and the value is a HashSet containing the allowable states the user can assign to the object.

Supported API: true

Parameters:

lcms - a collection of lifecycle managed objects

Returns:

WTKeyedMap

Throws:

WTException

navigate

public Map navigate(WTCollection c,
                    Transition transition,
                    boolean successor)
             throws WTException,
                    LifeCycleException

Navigate the PhaseSuccessors for the Transition for all objects in the WTCollection. Calls single-object navigate. Use multi-object instead.

Supported API: true

Parameters:

c - a collection of lifecycle managed objects

transition - the transition to navigate

successor - boolean value to indicate if the navigate should be to a successor state

Returns:

Map

Throws:

WTException

LifeCycleException

getSignatures

public ArrayList getSignatures(LifeCycleHistory history)
                        throws WTException

returns an ArrayList of LifeCycleSignatures for a LifeCycleHistory

Supported API: false

Parameters:

history - the LifeCycleHistory of interest

Returns:

ArrayList

Throws:

WTException

getCriterion

public ArrayList getCriterion(LifeCycleHistory history)
                       throws WTException

returns an ArrayList of Criterion for a LifeCycleHistory

Supported API: false

Parameters:

history - the LifeCycleHistory of interest

Returns:

ArrayList

Throws:

WTException

setLifeCycleState

public LifeCycleManaged setLifeCycleState(LifeCycleManaged object,
                                          State state,
                                          boolean terminAssocRunningProcesses,
                                          Timestamp timestamp)
                                   throws WTException,
                                          LifeCycleException

Set the state of the Life Cycle Managed object.

Supported API: true

Parameters:

object - The LifeCycleManaged object whose state should be updated

state - The state to set the LifeCycleManaged object to.

terminAssocRunningProcesses - a flag that determines whether or not to terminate the wf processes associated with this phase that are OPEN_RUNNING

timestamp - An optional parameter that allows specification of the created and modified timestamps for the history objects.

Returns:

LifeCycleManaged

Throws:

WTException

LifeCycleException

navigate

public Map navigate(WTKeyedMap c,
                    Transition transition,
                    boolean successor)
             throws WTException,
                    LifeCycleException

Navigates the PhaseTemplate->PhaseSuccession using param transition. Returns a WTKeyedMap where the keys are the keys passed in param c and the values WTKeyedHashMap where the keys are PhaseTemplates and the values are sets of inflated PhaseSuccessions.

Usage:

WTKeyedHashMap map=new WTKeyedHashMap(); Set set = new Set[) state=State.toState("DESIGN") set.add(state) map.put(lifecycleManagedObject, set) WTKeyedHashSet returnMap = LifeCycleHelper.service.navigate(map, Transition.toTransition("SET_STATE"), true)

Supported API: true

Parameters:

c - A WTKeyedMap that contains as its keys LifecycleManagedObject or LifeCycleTemplates and the values are a set of states to navigate.

transition - the name of the transition to navigate

successor - specifies whether or not to return the successor state or the predessor.

Returns:

Map

Throws:

WTException

LifeCycleException

getSeriesSelectors

public WTKeyedMap getSeriesSelectors(WTSet lcms)
                              throws WTException

Given a WTSet of objects, returns a WTKeyedMap whose keys are those elements of the argument set that are LifeCycleManaged and whose values are the keys' corresponding SeriesRangeSelector values for their current states, if applicable. If a key's current state does not have a SeriesRangeSelector, it is mapped to null.

Supported API: true

Parameters:

lcms - set of objects. Those that are not wt.lifecycle.LifeCycleManaged are ignored (and are excluded from the result).

Returns:

WTKeyedMap

Throws:

WTException

createDefaultTransitions

public void createDefaultTransitions(WTCollection lifeCycleTemplates)
                              throws WTException

Creates all default transitions for all life cycle templates in the specirfied collection, according to the directives specified in the wt.properties system configuration. It is the caller's responsibility to ensure that the invocation of this method will not result in transition duplication, which will result in an exception's being thrown. In general, the only way to ensure this is to invoke this method only on life cycle templates that have no transitions defined (not counting NEXT transitions, which are for internal usage and may not be specified for default initialization).

Supported API: false

Parameters:

lifeCycleTemplates - a collection of lifecycle templates to create transitions for

Throws:

WTException

saveLifeCycleTemplate

public TransactionResult saveLifeCycleTemplate(TransactionContainer aTran,
                                               WTContainerRef context,
                                               boolean bypassDefaultTransitions)
                                        throws WTException,
                                               LifeCycleException

Store or update a LifeCycleTemplate. This method accepts and processes a batch container of persistence assertions. If a WTContainerRef is passed, and it is different that that of this templates master; then a new master is created in the passed WTContainer, and this template becomes the first iteration.

Supported API: true

Parameters:

aTran - a TransactionContainer that contains a set of LifeCycleTemplate, PhaseTemplate, AdHocAclSpec, Criterion and Transition assertions and transitions that need to be applied against one or more LifeCycleTemplate objects

context - the container the template is being saved in

bypassDefaultTransitions - specifies whether or not the default transitions should be created. if set to true, the transitions must be specified in the transaction container

Returns:

TransactionResult

Throws:

WTException

LifeCycleException

findTransitions

public Set findTransitions(WTSet promotables)
                    throws WTException

For a given Set of promotables return the intersection of thier common Transitions.

Supported API: false

Parameters:

promotables -

Returns:

Set

Throws:

WTException

findTransitions

public Set findTransitions(WTSet promotables,
                           Transition transition)
                    throws WTException

For a given Set of Promotables, return the intersection of common Transitions. Note: This will either return a Set of 1 namely the passed in transition of an empty set.

Supported API: false

Parameters:

promotables -

transition -

Returns:

Set

Throws:

WTException

setLifeCycleState

public WTList setLifeCycleState(WTList list,
                                Map stateMap,
                                WTList terminateList)
                         throws WTException,
                                LifeCycleException

Set the state of the Life Cycle Managed objects in the WTList list. Set state values are in the Map stateMap where the key is the LCMO in list and the value is a State. Also this method will terminate any workflow processes accociated in WTList terminateList.

Supported API: true

Parameters:

list - The LifeCycleManaged objects whose state should be updated

stateMap - The state to set the LifeCycleManaged object to. Key=LCMO, value State

terminateList - The LifeCycleManaged objects whose workflow processes should be terminated.

Returns:

WTList

Throws:

WTException

LifeCycleException