wt.lifecycle
Interface LifeCycleServiceSvr

All Known Implementing Classes:

StandardLifeCycleService

public interface LifeCycleServiceSvr

These methods are can only be invoked from classes running in the server.

Supported API: false

Extendable: false

See Also:

LifeCycleServerHelper

Method Summary

Persistable	assignToLifeCycle(Persistable object) Associate a life cycle managed object with a life cycle.
void	demote(WTObject object) Demote the object to the previous phase.
void	deny(WTObject object) Return the object to the submitter, removing it from the gate.
LifeCycleManaged	doDemote(LifeCycleManaged object, LifeCycleSignature signature) Transition the object to its previous phase, updating its state, initiating the appropriate workflow and recording history.
LifeCycleManaged	doDeny(LifeCycleManaged object, LifeCycleSignature signature) Transition the object from the gate back to the phase, initating the appropriate workflow and recording history.
LifeCycleManaged	doDrop(LifeCycleManaged object, LifeCycleSignature signature) Remove the object from the life cycle and set its state to DROPPED.
LifeCycleManaged	doPromote(LifeCycleManaged object, LifeCycleSignature signature) Transition the object to its next phase, updating its state, initiating the appropriate workflow and recording history.
LifeCycleManaged	doReassign(LifeCycleManaged object, LifeCycleTemplateReference lctRef) Re-assign the object to a new life cycle.
LifeCycleManaged	doSetState(LifeCycleManaged object, PhaseTemplate aPhaseTemplate) Sets the state of the object.
LifeCycleManaged	doSubmit(LifeCycleManaged object) Submit the object for review.
void	drop(WTObject object) Transition the object to an end state.
String	getPhaseName(LifeCycleManaged object) Answer the phase name of the current phase for the specified life cycle managed object Supported API: false
Enumeration	getRunningInstances(String templateName) Deprecated. at 5.0 - Use the whereUsed methods instead.
void	promote(WTObject object) Promote an object to the next phase.
LifeCycleHistory	saveHistory(LifeCycleManaged object, Phase aPhase, String event) Create a history entry based on a life cycle event.
LifeCycleManaged	setState(LifeCycleManaged object, int aStateOrdinal) Transition the object to an different state.
LifeCycleManaged	setState(LifeCycleManaged object, State aState) Transition the object to an different state.
WTList	setState(WTList list, Map map) Transition the objects in the collection to a different state.
WTList	setState(WTList list, State aState) Transition the objects in the collection to a different state.
WTObject	setState(WTObject object, Integer aStateOrdinal) Used to Validate the WTObject from the robot and pass onto setState.
WTObject	setState(WTObject object, State aState) Used to Validate the WTObject from the robot and pass onto setState.
void	submit(WTObject object) Submit the object for review.
LifeCycleSignature	validateDemote(LifeCycleManaged object, LifeCycleSignature signature) Perform pre-demote validations Supported API: false
LifeCycleSignature	validateDeny(LifeCycleManaged object, LifeCycleSignature signature) Perform pre-deny validations Supported API: false
LifeCycleSignature	validateDrop(LifeCycleManaged object, LifeCycleSignature signature) Perform pre-drop validations Supported API: false
LifeCycleSignature	validatePromote(LifeCycleManaged object, LifeCycleSignature signature) Perform pre-promote validations Supported API: false
LifeCycleManaged	validateReassign(LifeCycleManaged object, LifeCycleTemplateReference lctRef) Perform pre-reassign validations Supported API: false
PhaseTemplate	validateSetState(LifeCycleManaged object, int aStateOrdinal) Used by setState, checks that the state the Workflow SetState robot is tying to set the object to is valid.
PhaseTemplate	validateSetState(LifeCycleManaged object, State aState) Used by setState, checks that the state the Workflow SetState robot is tying to set the object to is valid.
LifeCycleManaged	validateSubmit(LifeCycleManaged object) Perform pre-submit validations Supported API: false
LifeCycleSignature	validateVote(LifeCycleManaged object, LifeCycleSignature signature) Perform pre-vote validations Supported API: false
QueryResult	whereUsed(LifeCycleTemplate aTemplate) Given a LifeCycleTemplate, return a QueryResult containing all LifeCycleManaged objects that use it Supported API: false
QueryResult	whereUsed(LifeCycleTemplateMaster aMaster) Given a LifeCycleTemplateMaster, return a QueryResult containing all LifeCycleManaged objects that use any iteration of it Supported API: false
QueryResult	whereUsed(WfProcessTemplate template) Given a WfProcessTemplate, return a QueryResult containing all PhaseTemplate objects that use it Supported API: false
QueryResult	whereUsed(WfProcessTemplateMaster master) Given a WfProcessTemplateMaster, return a QueryResult containing all PhaseTemplate objects that use it.

Method Detail

assignToLifeCycle

public Persistable assignToLifeCycle(Persistable object)
                              throws WTException,
                                     LifeCycleException

Associate a life cycle managed object with a life cycle. This includes assigning an initial state to the object.

Supported API: false

Parameters:

object - the Persistable object that the caller wants assigned to a life cycle

Returns:

Persistable

Throws:

WTException

LifeCycleException

doSubmit

public LifeCycleManaged doSubmit(LifeCycleManaged object)
                          throws WTException,
                                 LifeCycleException

Submit the object for review. This initiates the appropriate workflow for the life cycle gate.

Supported API: false

Parameters:

object - the LifeCycleManaged object that should be submitted for review

Returns:

LifeCycleManaged

Throws:

WTException

LifeCycleException

doPromote

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

Transition the object to its next phase, updating its state, initiating the appropriate workflow and recording history.

Supported API: false

Parameters:

object - the LifeCycleManaged object to be promoted

signature - the LifeCycleSignature object to be used to record information about the promote

Returns:

LifeCycleManaged

Throws:

WTException

LifeCycleException

doDemote

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

Transition the object to its previous phase, updating its state, initiating the appropriate workflow and recording history.

Supported API: false

Parameters:

object - the LifeCycleManaged object to be used in the demote

signature - the LifeCycleSignature object to be used to record information about the demote

Returns:

LifeCycleManaged

Throws:

WTException

LifeCycleException

doDeny

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

Transition the object from the gate back to the phase, initating the appropriate workflow and recording history.

Supported API: false

Parameters:

object - the LifeCycleManaged object to be used in the demote

signature - the LifeCycleSignature object to be used to record information about the demote

Returns:

LifeCycleManaged

Throws:

WTException

LifeCycleException

doDrop

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

Remove the object from the life cycle and set its state to DROPPED. Also, terminate the associated workflow(s).

Supported API: false

Parameters:

object - the LifeCycleManaged object to be used in the demote

signature - the LifeCycleSignature object to be used to record information about the demote

Returns:

LifeCycleManaged

Throws:

WTException

LifeCycleException

doReassign

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

Re-assign the object to a new life cycle. Transfer current phase information to history.

Supported API: false

Parameters:

object - the LifeCycleManaged object to be reassigned

lctRef -

Returns:

LifeCycleManaged

Throws:

WTException

LifeCycleException

validateSubmit

public LifeCycleManaged validateSubmit(LifeCycleManaged object)
                                throws WTException,
                                       LifeCycleException

Perform pre-submit validations

Supported API: false

Parameters:

object - the LifeCycleManaged object to be submitted

Returns:

LifeCycleManaged

Throws:

WTException

LifeCycleException

validatePromote

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

Perform pre-promote validations

Supported API: false

Parameters:

object - the LifeCycleManaged object to be promoted

signature - the LifeCycleSignature object to be used to record information about the promote

Returns:

LifeCycleSignature

Throws:

WTException

LifeCycleException

validateDemote

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

Perform pre-demote validations

Supported API: false

Parameters:

object - the LilfeCycleManaged object to be demoted

signature - the LifeCycleSignature object used to record information about the demote

Returns:

LifeCycleSignature

Throws:

WTException

LifeCycleException

validateDeny

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

Perform pre-deny validations

Supported API: false

Parameters:

object - the LilfeCycleManaged object to be demoted

signature - the LifeCycleSignature object used to record information about the demote

Returns:

LifeCycleSignature

Throws:

WTException

LifeCycleException

validateDrop

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

Perform pre-drop validations

Supported API: false

Parameters:

object - the LifeCycleManaged object that should be voted on

signature - the LifeCycleSignature object used to record information about the vote

Returns:

LifeCycleSignature

Throws:

WTException

LifeCycleException

validateVote

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

Perform pre-vote validations

Supported API: false

Parameters:

object - the LifeCycleManaged object that should be voted on

signature - the LifeCycleSignature object used to record information about the vote

Returns:

LifeCycleSignature

Throws:

WTException

LifeCycleException

validateReassign

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

Perform pre-reassign validations

Supported API: false

Parameters:

object - the LifeCycleManaged object that should be reassigned

lctRef -

Returns:

LifeCycleManaged

Throws:

WTException

LifeCycleException

saveHistory

public LifeCycleHistory saveHistory(LifeCycleManaged object,
                                    Phase aPhase,
                                    String event)
                             throws WTException,
                                    LifeCycleException

Create a history entry based on a life cycle event. This method is invoked for each of:

 1. StandardLifeCycleService.ENTER_PHASE
    #  Default: History event recorded
 2. StandardLifeCycleService.SUBMIT
    # Default: History event recorded
 3. StandardLifeCycleService.PROMOTE
    # Default: History event recorded
 4. StandardLifeCycleService.VOTE
    # Default: Signature created but no history event recorded
 5. StandardLifeCycleService.DEMOTE
    # Default: History event recorded
 6. StandardLifeCycleService.DROP
    # Default: History event recorded
 7. StandardLifeCycleService.DENY
    # Default: History event recorded
 8. StandardLifeCycleService.RETEAM
    # Default: History event recorded
 9. StandardLifeCycleService.REASSIGN
    # Default: History event recorded
 

Supported API: false

Parameters:

object - the LifeCycleManaged object that the history is associated to

aPhase - the Phase object that the history will be associated to

event - the name of the event that History is associated to

Returns:

LifeCycleHistory

Throws:

WTException

LifeCycleException

getPhaseName

public String getPhaseName(LifeCycleManaged object)
                    throws WTException,
                           LifeCycleException

Answer the phase name of the current phase for the specified life cycle managed object

Supported API: false

Parameters:

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

Returns:

String

Throws:

WTException

LifeCycleException

getRunningInstances

public Enumeration getRunningInstances(String templateName)
                                throws WTException,
                                       LifeCycleException

Deprecated. at 5.0 - Use the whereUsed methods instead.

Answer an enumeration of LifeCycleManaged objects current in the specified life cycle. Caution - this could be a large result set.

Supported API: false

Parameters:

templateName - the name of the LifeCycleTemplate used as search criteria in the retrieval of LifeCycleManaged objects associated to the LifeCycleTemplate name

Returns:

Enumeration

Throws:

WTException

LifeCycleException

submit

public void submit(WTObject object)
            throws WTException,
                   LifeCycleException

Submit the object for review. This executes doSubmit. This method should be used by the Workflow robot to complete a Submit.

Supported API: false

Parameters:

object - the LifeCycleManaged object that should be submitted for approval

Throws:

WTException

LifeCycleException

promote

public void promote(WTObject object)
             throws WTException,
                    LifeCycleException

Promote an object to the next phase. This executes doPromote. This method should be used by the Workflow robot to promote the object to the next phase. If the object is not already at the gate, the Submit robotable method is first executed.

Supported API: false

Parameters:

object - the LifeCycleManaged object that should be promoted

Throws:

WTException

LifeCycleException

demote

public void demote(WTObject object)
            throws WTException,
                   LifeCycleException

Demote the object to the previous phase. This executes the doDemote method. This method should be used by the Workflow robot.

Supported API: false

Parameters:

object - the LifeCycleManaged object that should be demoted.

Throws:

WTException

LifeCycleException

deny

public void deny(WTObject object)
          throws WTException,
                 LifeCycleException

Return the object to the submitter, removing it from the gate. This process executes the doDeny method. This method should be used by the Workflow robot.

Supported API: false

Parameters:

object - the LifeCycleManaged object that should be denied

Throws:

WTException

LifeCycleException

drop

public void drop(WTObject object)
          throws WTException,
                 LifeCycleException

Transition the object to an end state. This process executes the doDrop. This method should be used by the Workflow robot.

Supported API: false

Parameters:

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

Throws:

WTException

LifeCycleException

setState

public LifeCycleManaged setState(LifeCycleManaged object,
                                 State aState)
                          throws WTException,
                                 LifeCycleException

Transition the object to an different state. This process executes the validateSetState. This method should be used by the Workflow SetState robot.

Supported API: false

Parameters:

object - the LifeCycleManaged object

aState - The state to set the LifeCycleManaged object to.

Returns:

LifeCycleManaged

Throws:

WTException

LifeCycleException

setState

public LifeCycleManaged setState(LifeCycleManaged object,
                                 int aStateOrdinal)
                          throws WTException,
                                 LifeCycleException

Transition the object to an different state. This process executes the validateSetState. This method should be used by the Workflow SetState robot.

Supported API: false

Parameters:

object - the LifeCycleManagedObject.

aStateOrdinal - The ordianal value of the state to set the LifeCycleManaged object to.

Returns:

LifeCycleManaged

Throws:

WTException

LifeCycleException

validateSetState

public PhaseTemplate validateSetState(LifeCycleManaged object,
                                      State aState)
                               throws WTException,
                                      LifeCycleException

Used by setState, checks that the state the Workflow SetState robot is tying to set the object to is valid.

Supported API: false

Parameters:

object - The LifeCycleManagedObject

aState - The state to set the LifeCycleManagedObject to, this state must be validated.

Returns:

PhaseTemplate

Throws:

WTException

LifeCycleException

validateSetState

public PhaseTemplate validateSetState(LifeCycleManaged object,
                                      int aStateOrdinal)
                               throws WTException,
                                      LifeCycleException

Used by setState, checks that the state the Workflow SetState robot is tying to set the object to is valid.

Supported API: false

Parameters:

object - The LifeCycleManagedObject.

aStateOrdinal - The state ordinal value to set the LifeCycleManagedObject to, this state must be validated.

Returns:

PhaseTemplate

Throws:

WTException

LifeCycleException

doSetState

public LifeCycleManaged doSetState(LifeCycleManaged object,
                                   PhaseTemplate aPhaseTemplate)
                            throws WTException,
                                   LifeCycleException

Sets the state of the object. Used by the Workflow SetState robot.

Supported API: false

Parameters:

object - The LifeCycleManagedObject

aPhaseTemplate - The phasetemplate to set the lifecyclemanagedobject to indicated by the state from setState.

Returns:

LifeCycleManaged

Throws:

WTException

LifeCycleException

whereUsed

public QueryResult whereUsed(LifeCycleTemplate aTemplate)
                      throws WTException,
                             LifeCycleException

Given a LifeCycleTemplate, return a QueryResult containing all LifeCycleManaged objects that use it

Supported API: false

Parameters:

aTemplate -

Returns:

QueryResult

Throws:

WTException

LifeCycleException

whereUsed

public QueryResult whereUsed(LifeCycleTemplateMaster aMaster)
                      throws WTException,
                             LifeCycleException

Given a LifeCycleTemplateMaster, return a QueryResult containing all LifeCycleManaged objects that use any iteration of it

Supported API: false

Parameters:

aMaster -

Returns:

QueryResult

Throws:

WTException

LifeCycleException

setState

public WTObject setState(WTObject object,
                         State aState)
                  throws WTException,
                         LifeCycleException

Used to Validate the WTObject from the robot and pass onto setState.

Supported API: false

Parameters:

object - The WTObject containing the LifeCycleManaged object.

aState - The state to set the LifeCycle to.

Returns:

WTObject

Throws:

WTException

LifeCycleException

setState

public WTObject setState(WTObject object,
                         Integer aStateOrdinal)
                  throws WTException,
                         LifeCycleException

Used to Validate the WTObject from the robot and pass onto setState.

Supported API: false

Parameters:

object - The WTObject containing the LifeCycleManaged object.

aStateOrdinal - A ordinal value which corresponds to a state in the LifeCycle.

Returns:

WTObject

Throws:

WTException

LifeCycleException

whereUsed

public QueryResult whereUsed(WfProcessTemplateMaster master)
                      throws WTException,
                             LifeCycleException

Given a WfProcessTemplateMaster, return a QueryResult containing all PhaseTemplate objects that use it.

Supported API: false

Parameters:

master -

Returns:

QueryResult

Throws:

WTException

LifeCycleException

whereUsed

public QueryResult whereUsed(WfProcessTemplate template)
                      throws WTException,
                             LifeCycleException

Given a WfProcessTemplate, return a QueryResult containing all PhaseTemplate objects that use it

Supported API: false

Parameters:

template -

Returns:

QueryResult

Throws:

WTException

LifeCycleException

setState

public WTList setState(WTList list,
                       State aState)
                throws WTException,
                       LifeCycleException

Transition the objects in the collection to a different state. This process executes the validateSetState. This method should be used by the Workflow SetState robot.

Supported API: false

Parameters:

list - a collection of lifecycle managed objects

aState - The state to set the LifeCycleManaged object to.

Returns:

WTList

Throws:

WTException

LifeCycleException

setState

public WTList setState(WTList list,
                       Map map)
                throws WTException,
                       LifeCycleException

Transition the objects in the collection to a different state. This process executes the validateSetState. This method should be used by the Workflow SetState robot.

Supported API: false

Parameters:

list - a collection of lifecycle managed objects

map - The state to set the LifeCycleManaged object to. Key= LCMO. Value = State.

Returns:

WTList

Throws:

WTException

LifeCycleException