Package org.dspace.xmlworkflow.state.actions.userassignment

Class ClaimAction

java.lang.Object

org.dspace.xmlworkflow.state.actions.Action

org.dspace.xmlworkflow.state.actions.userassignment.UserSelectionAction

org.dspace.xmlworkflow.state.actions.userassignment.ClaimAction

public class ClaimAction
extends UserSelectionAction

Processing class for an action where x number of users have to accept a task from a designated pool

Author:

Bram De Schouwer (bram.deschouwer at dot com), Kevin Van de Velde (kevin at atmire dot com), Ben Bosman (ben at atmire dot com), Mark Diggory (markd at atmire dot com)

Field Summary

Fields inherited from class org.dspace.xmlworkflow.state.actions.userassignment.UserSelectionAction

claimedTaskService, log, poolTaskService, workflowItemRoleService

Constructor Summary

Constructors

Constructor	Description
ClaimAction()

Method Summary

Modifier and Type	Method	Description
void	activate(Context context, XmlWorkflowItem wfItem)	Called when a workflow item becomes eligible for this Action.
void	alertUsersOnActivation(Context c, XmlWorkflowItem wfi, RoleMembers roleMembers)	Notify action role members that an item requires action.
ActionResult	execute(Context c, XmlWorkflowItem wfi, Step step, jakarta.servlet.http.HttpServletRequest request)	Called when the action is to be performed.
List<String>	getOptions()	Returns a list of options that the user can select at this action which results in the next step in the workflow
boolean	isFinished(XmlWorkflowItem wfi)
boolean	isValidUserSelection(Context context, XmlWorkflowItem wfi, boolean hasUI)	Check user constraints (enough users, group exists, ...).
void	regenerateTasks(Context c, XmlWorkflowItem wfi, RoleMembers roleMembers)	Should a person have the option to repool the task the tasks will have to be regenerated
boolean	usesTaskPool()	A boolean indicating whether or not the task pool is used for this type of user selection

Methods inherited from class org.dspace.xmlworkflow.state.actions.userassignment.UserSelectionAction

isAuthorized

Methods inherited from class org.dspace.xmlworkflow.state.actions.Action

addApprovedProvenance, addErrorField, getAdvancedInfo, getAdvancedOptions, getErrorFields, getParent, getProvenanceStartId, isAdvanced, isOptionInParam, setParent

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

ClaimAction

public ClaimAction()

Method Details

activate

public void activate(Context context,
 XmlWorkflowItem wfItem)
              throws SQLException,
IOException,
AuthorizeException

Description copied from class: Action

Called when a workflow item becomes eligible for this Action.

Specified by:

activate in class Action

Parameters:

context - current DSpace session.

wfItem - the eligible item.

Throws:

SQLException - passed through.

IOException - passed through.

AuthorizeException - passed through.

execute

public ActionResult execute(Context c,
 XmlWorkflowItem wfi,
 Step step,
 jakarta.servlet.http.HttpServletRequest request)
                     throws SQLException,
AuthorizeException,
IOException

Description copied from class: Action

Called when the action is to be performed.

Specified by:

execute in class Action

Parameters:

c - current DSpace session.

wfi - the item on which the action is to be performed.

step - the workflow step in which the action is performed.

request - the current client request.

Returns:

the result of performing the action.

Throws:

SQLException - passed through.

AuthorizeException - passed through.

IOException - passed through.

getOptions

public List<String> getOptions()

Description copied from class: Action

Returns a list of options that the user can select at this action which results in the next step in the workflow

Specified by:

getOptions in class Action

Returns:

A list of options of this action, resulting in the next step of the workflow

alertUsersOnActivation

public void alertUsersOnActivation(Context c,
 XmlWorkflowItem wfi,
 RoleMembers roleMembers)
                            throws IOException,
SQLException

Description copied from class: Action

Notify action role members that an item requires action.

Overrides:

alertUsersOnActivation in class Action

Parameters:

c - current DSpace session.

wfi - the needy item.

roleMembers - users who may fulfill the role.

Throws:

IOException - passed through.

SQLException - passed through.

regenerateTasks

public void regenerateTasks(Context c,
 XmlWorkflowItem wfi,
 RoleMembers roleMembers)
                     throws SQLException,
AuthorizeException,
IOException

Description copied from class: UserSelectionAction

Should a person have the option to repool the task the tasks will have to be regenerated

Specified by:

regenerateTasks in class UserSelectionAction

Parameters:

c - the dspace context

wfi - the workflowitem

roleMembers - the list of users for which tasks must be regenerated

Throws:

SQLException - An exception that provides information on a database access error or other errors.

AuthorizeException - thrown if the current user isn't authorized

IOException - A general class of exceptions produced by failed or interrupted I/O operations.

isFinished

public boolean isFinished(XmlWorkflowItem wfi)

Specified by:

isFinished in class UserSelectionAction

isValidUserSelection

public boolean isValidUserSelection(Context context,
 XmlWorkflowItem wfi,
 boolean hasUI)
                             throws WorkflowConfigurationException,
SQLException

Description copied from class: UserSelectionAction

Check user constraints (enough users, group exists, ...).

Specified by:

isValidUserSelection in class UserSelectionAction

Parameters:

context - the dspace context

wfi - the workflow item

hasUI - whether or not the Step has a user interface

Returns:

if the action is valid

Throws:

WorkflowConfigurationException - if there is an error in the workflow configuration.

SQLException - passed through.

usesTaskPool

public boolean usesTaskPool()

Description copied from class: UserSelectionAction

A boolean indicating whether or not the task pool is used for this type of user selection

Specified by:

usesTaskPool in class UserSelectionAction

Returns:

a boolean