org.dspace.xmlworkflow.service

Interface XmlWorkflowService

All Superinterfaces:

WorkflowService<XmlWorkflowItem>

All Known Implementing Classes:

XmlWorkflowServiceImpl

public interface XmlWorkflowService
extends WorkflowService<XmlWorkflowItem>

When an item is submitted and is somewhere in a workflow, it has a row in the WorkflowItem table pointing to it. Once the item has completed the workflow it will be archived

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)

Method Summary

Methods

Modifier and Type	Method and Description
void	alertUsersOnTaskActivation(Context c, XmlWorkflowItem wfi, String emailTemplate, List<EPerson> epa, String... arguments)
void	createOwnedTask(Context context, XmlWorkflowItem wi, Step step, WorkflowActionConfig action, EPerson e)
void	createPoolTasks(Context context, XmlWorkflowItem wi, RoleMembers assignees, Step step, WorkflowActionConfig action)
void	deleteAllPooledTasks(Context c, XmlWorkflowItem wi)
void	deleteAllTasks(Context context, XmlWorkflowItem wi)
void	deleteClaimedTask(Context c, XmlWorkflowItem wi, ClaimedTask task)
void	deletePooledTask(Context context, XmlWorkflowItem wi, PoolTask task)
WorkflowActionConfig	doState(Context c, EPerson user, javax.servlet.http.HttpServletRequest request, int workflowItemId, Workflow workflow, WorkflowActionConfig currentActionConfig)
String	getEPersonName(EPerson ePerson)
WorkflowActionConfig	processOutcome(Context c, EPerson user, Workflow workflow, Step currentStep, WorkflowActionConfig currentActionConfig, ActionResult currentOutcome, XmlWorkflowItem wfi, boolean enteredNewStep)

Methods inherited from interface org.dspace.workflow.WorkflowService

abort, addInitialWorkspaceItemPolicies, archive, deleteCollection, getEPersonDeleteConstraints, getFlywayMigrationLocations, getMyDSpaceLink, getWorkflowRoleGroup, sendWorkflowItemBackSubmission, start, startWithoutNotify

Method Detail

alertUsersOnTaskActivation

void alertUsersOnTaskActivation(Context c,
                              XmlWorkflowItem wfi,
                              String emailTemplate,
                              List<EPerson> epa,
                              String... arguments)
                                throws IOException,
                                       SQLException,
                                       javax.mail.MessagingException

Throws:

IOException

SQLException

javax.mail.MessagingException

doState

WorkflowActionConfig doState(Context c,
                           EPerson user,
                           javax.servlet.http.HttpServletRequest request,
                           int workflowItemId,
                           Workflow workflow,
                           WorkflowActionConfig currentActionConfig)
                             throws SQLException,
                                    AuthorizeException,
                                    IOException,
                                    javax.mail.MessagingException,
                                    WorkflowException

Throws:

SQLException

AuthorizeException

IOException

javax.mail.MessagingException

WorkflowException

processOutcome

WorkflowActionConfig processOutcome(Context c,
                                  EPerson user,
                                  Workflow workflow,
                                  Step currentStep,
                                  WorkflowActionConfig currentActionConfig,
                                  ActionResult currentOutcome,
                                  XmlWorkflowItem wfi,
                                  boolean enteredNewStep)
                                    throws IOException,
                                           AuthorizeException,
                                           SQLException,
                                           WorkflowException

Throws:

IOException

AuthorizeException

SQLException

WorkflowException

deleteAllTasks

void deleteAllTasks(Context context,
                  XmlWorkflowItem wi)
                    throws SQLException,
                           AuthorizeException

Throws:

SQLException

AuthorizeException

deleteAllPooledTasks

void deleteAllPooledTasks(Context c,
                        XmlWorkflowItem wi)
                          throws SQLException,
                                 AuthorizeException

Throws:

SQLException

AuthorizeException

deletePooledTask

void deletePooledTask(Context context,
                    XmlWorkflowItem wi,
                    PoolTask task)
                      throws SQLException,
                             AuthorizeException

Throws:

SQLException

AuthorizeException

deleteClaimedTask

void deleteClaimedTask(Context c,
                     XmlWorkflowItem wi,
                     ClaimedTask task)
                       throws SQLException,
                              AuthorizeException

Throws:

SQLException

AuthorizeException

createPoolTasks

void createPoolTasks(Context context,
                   XmlWorkflowItem wi,
                   RoleMembers assignees,
                   Step step,
                   WorkflowActionConfig action)
                     throws SQLException,
                            AuthorizeException

Throws:

SQLException

AuthorizeException

createOwnedTask

void createOwnedTask(Context context,
                   XmlWorkflowItem wi,
                   Step step,
                   WorkflowActionConfig action,
                   EPerson e)
                     throws SQLException,
                            AuthorizeException

Throws:

SQLException

AuthorizeException

getEPersonName

String getEPersonName(EPerson ePerson)