com.polarion.alm.tracker.workflow.IWorkflowManager


METHODS
Modifiers and TypeNameDescription
IWorkflowAction[] getAvailableActions(IWorkflowObject) The workflow actions available for the target object. Which actions are available depends on the type of the object (@see IWorkflowObject#getType()), status of the object (@see {@link IWorkflowObject#getStatus()} ) and the result of validating the conditions.
Map getUnavailableActions(IWorkflowObject) The workflow actions unavailable for the target object.
Map getAllActions(IWorkflowObject) The workflow actions both available and unavailable for the target object.
IWorkflowAction getInitialAction(IWorkflowObject) Returns the initial workflow action if it is defined for this workflow. The initial action is always called implicitly by the system and is made available through this method so that interested clients can check, for example, the list of required features.
void handleSave(IWorkflowObject) Called internally. Clients should not call this method themselves.
IPObjectList performAction(IWorkflowObject,int) Performs the given worflow action. The action might modify some other objects as well - in such a case the list with the modified objects is returned.

This allows clients to handle that correctly - e.g. present this list to the user for approval, etc.

void resetWorkflow(IWorkflowObject) Resets the workflow so that the target enters the initial status. If there is initial workflow action defined, it will be registered and called on commit or before next workflow (whatever comes first).

Open transaction is required to call this method.

Called by the target whenever the type changes.

IContributionsManager getContributionsManager()
IWorkflowConfig getWorkflowConfig(IWorkflowObject) Returns workflow configuration that is used for the target object (it can be inherited from a different context or type). Returns null if no workflow configuration exists, or if it cannot be used because of some problem.
IWorkflowConfig getWorkflowConfig(String,String,IContextId) Returns workflow configuration that is used for the objects of given prototype and type in the given context (it can be inherited from a different context or type). Returns null if no workflow configuration exists, or if it cannot be used because of some problem.
IWorkflowConfig readWorkflowConfig(String,String,IContextId) Returns the workflow which corresponds exactly to the given context, type and prototype, returns null if no workflow is defined for this combination of parameters.

Note, that even is null is returned, there still might be a workflow configuration inherited from parent contexts or typeless one.

void updateWorkflowConfig(IWorkflowConfig,String,IContextId) Stores the given workflow configuration to the repository (for the prototype config.getPrototype()).
ISignatureStateOpt calculateSignatureState(IWorkflowObject,String,List) Returns signature state of the transition from current status of the target object to the target status.
String getSignatureStateMessage(IWorkflowObject,String,ISignatureStateOpt) Returns message for the signature state of the transition from current status of the target object to the target status. The message is usually provided by the signature policy of the transition.

Back to Index