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

log

Constructor Summary

Constructors

Constructor and Description
ClaimAction()

Method Summary

Methods

Modifier and Type	Method and Description
void	activate(Context context, XmlWorkflowItem wfItem)
void	alertUsersOnActivation(Context c, XmlWorkflowItem wfi, RoleMembers roleMembers)
ActionResult	execute(Context c, XmlWorkflowItem wfi, Step step, javax.servlet.http.HttpServletRequest request)
boolean	isFinished(XmlWorkflowItem wfi)
boolean	isValidUserSelection(Context context, XmlWorkflowItem wfi, boolean hasUI) Verifies if the user selection action is valid User constraints will be checked (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 wether 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

addErrorField, getErrorFields, getParent, getProvenanceStartId, setParent

Methods inherited from class java.lang.Object

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

Constructor Detail

ClaimAction

public ClaimAction()

Method Detail

activate

public void activate(Context context,
            XmlWorkflowItem wfItem)
              throws java.sql.SQLException,
                     java.io.IOException,
                     AuthorizeException

Specified by:

activate in class Action

Throws:

java.sql.SQLException

java.io.IOException

AuthorizeException

execute

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

Specified by:

execute in class Action

Throws:

java.sql.SQLException

AuthorizeException

java.io.IOException

alertUsersOnActivation

public void alertUsersOnActivation(Context c,
                          XmlWorkflowItem wfi,
                          RoleMembers roleMembers)
                            throws java.io.IOException,
                                   java.sql.SQLException

Overrides:

alertUsersOnActivation in class Action

Throws:

java.io.IOException

java.sql.SQLException

regenerateTasks

public void regenerateTasks(Context c,
                   XmlWorkflowItem wfi,
                   RoleMembers roleMembers)
                     throws java.sql.SQLException,
                            AuthorizeException

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:

java.sql.SQLException - ...

AuthorizeException - thrown if the current user isn't authorized

isFinished

public boolean isFinished(XmlWorkflowItem wfi)

Specified by:

isFinished in class UserSelectionAction

isValidUserSelection

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

Description copied from class: UserSelectionAction

Verifies if the user selection action is valid User constraints will be checked (enough users, group exists, ...)

Specified by:

isValidUserSelection in class UserSelectionAction

Parameters:

context - the dspace context

wfi - the workflow item

hasUI - boolean indicating whether or not the action has a user interface

Returns:

if the action is valid

Throws:

WorkflowConfigurationException - occurs if there is a configuration error in the workflow

java.sql.SQLException - ...

usesTaskPool

public boolean usesTaskPool()

Description copied from class: UserSelectionAction

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

Specified by:

usesTaskPool in class UserSelectionAction

Returns:

a boolean