/**
* The contents of this file are subject to the license and copyright
* detailed in the LICENSE and NOTICE files at the root of the source
* tree and available online at
*
* http://www.dspace.org/license/
*/
package org.dspace.xmlworkflow.state.actions.userassignment;
import org.apache.log4j.Logger;
import org.dspace.authorize.AuthorizeException;
import org.dspace.core.Context;
import org.dspace.xmlworkflow.state.actions.Action;
import org.dspace.xmlworkflow.storedcomponents.*;
import org.dspace.xmlworkflow.RoleMembers;
import org.dspace.xmlworkflow.WorkflowConfigurationException;
import javax.servlet.http.HttpServletRequest;
import java.io.IOException;
import java.sql.SQLException;
/**
* An abstract class representing the processing side of
* a user selection action.
* All the user selection actions must inherit from this action
*
* @author Bram De Schouwer (bram.deschouwer at dot com)
* @author Kevin Van de Velde (kevin at atmire dot com)
* @author Ben Bosman (ben at atmire dot com)
* @author Mark Diggory (markd at atmire dot com)
*/
public abstract class UserSelectionAction extends Action {
protected static Logger log = Logger.getLogger(UserSelectionAction.class);
public abstract boolean isFinished(XmlWorkflowItem wfi);
@Override
public boolean isAuthorized(Context context, HttpServletRequest request, XmlWorkflowItem wfi) throws SQLException, AuthorizeException, IOException, WorkflowConfigurationException {
PoolTask task = null;
if(context.getCurrentUser() != null)
task = PoolTask.findByWorkflowIdAndEPerson(context, wfi.getID(), context.getCurrentUser().getID());
//Check if we have pooled the current task
return task != null &&
task.getWorkflowID().equals(getParent().getStep().getWorkflow().getID()) &&
task.getStepID().equals(getParent().getStep().getId()) &&
task.getActionID().equals(getParent().getId());
}
/**
* Should a person have the option to repool the task the tasks will have to be regenerated
* @param c the dspace context
* @param wfi the workflowitem
* @param roleMembers the list of users for which tasks must be regenerated
* @throws SQLException ...
* @throws AuthorizeException thrown if the current user isn't authorized
*/
public abstract void regenerateTasks(Context c, XmlWorkflowItem wfi, RoleMembers roleMembers) throws SQLException, AuthorizeException;
/**
* Verifies if the user selection action is valid
* User constraints will be checked (enough users, group exists, ...)
* @param context the dspace context
* @param wfi the workflow item
* @param hasUI boolean indicating whether or not the action has a user interface
* @return if the action is valid
* @throws WorkflowConfigurationException occurs if there is a configuration error in the workflow
* @throws SQLException ...
*/
public abstract boolean isValidUserSelection(Context context, XmlWorkflowItem wfi, boolean hasUI) throws WorkflowConfigurationException, SQLException;
/**
* A boolean indicating wether or not the task pool is used for this type of user selection
* @return a boolean
*/
public abstract boolean usesTaskPool();
}