Package com.polarion.alm.tracker.model
Interface IWorkflowAction
public interface IWorkflowAction
- Author:
- Michal Dobisek, Polarion Software
-
Method Summary
Modifier and TypeMethodDescriptionint
Returns the aplication internal action id.Returns the name of this action.String[]
Returns the keys that will be (set to null) during the action.Returns the action id as defined in workflow configuration.String[]
Returns the keys of fields that have to be set to perform this action.String[]
Returns the ids of roles that the user has to have to perform this action.String[]
Returns the keys that should be edited before performing the action.Returns the target status of this action.boolean
hasCurrentUserRequiredRoles
(IContextId contextId) Returns whether current user has at least one of the roles required to perform this action.boolean
Returns true if a signature (ISignature
) by current user is automatically added when the action is performed.boolean
Returns true if this action requires signature by some users.
-
Method Details
-
getNativeActionId
Returns the action id as defined in workflow configuration.- Returns:
- a
String
object representing the action id as defined in workflow configuration
-
getActionId
int getActionId()Returns the aplication internal action id.- Returns:
- a
String
object representing the application internal action id
-
getActionName
Returns the name of this action.- Returns:
- a
String
object representing the name of this action
-
getRequiredFeatures
Returns the keys of fields that have to be set to perform this action.- Returns:
- an array containing
String
s representing the keys of fields that have to be set to perform this action
-
getSuggestedFeatures
Returns the keys that should be edited before performing the action.- Returns:
- an
String
array containing the keys of fields that should be edited
-
getCleanedFeatures
Returns the keys that will be (set to null) during the action.- Returns:
- an array containing
String
s representing fields that will be set tonull
, when the action is performed
-
getRequiredRoles
Returns the ids of roles that the user has to have to perform this action. It is enough to have just one of these roles, there is OR connection among them.- Returns:
- an array containing
String
s representing the ids of roles one of which (at least) the user has to have to perform this action - Since:
- 3.5.3
-
hasCurrentUserRequiredRoles
Returns whether current user has at least one of the roles required to perform this action. Note that special roles 'workitem.author' and 'workitem.assignee' are not treated as required by this method.- Parameters:
contextId
-- Since:
- 3.5.3
-
getTargetStatus
Returns the target status of this action. The target status is the status a work item will have after the action was executed on it.- Returns:
- the
IStatusOpt
object that represents the target status of this action
-
isSignatureRequired
boolean isSignatureRequired()Returns true if this action requires signature by some users. ForIWorkItem
actions this means that the user will have to e-sign (using pop up dialog) the transition when performing this action in the UI. ForIModule
actions this means that the users can add theirISignature
s for the action and the action may become unavailable depending on a signature policy and the present signatures. If this action automatically adds signature by current user (seeisAddingSignature()
), the user will have to e-sign (using pop up dialog) the transition when performing this action in the UI.- Since:
- 3.9.0
-
isAddingSignature
boolean isAddingSignature()Returns true if a signature (ISignature
) by current user is automatically added when the action is performed.- Since:
- 3.9.0
-