org.dspace.xmlworkflow

Class XmlWorkflowManager

java.lang.Object

org.dspace.xmlworkflow.XmlWorkflowManager

public class XmlWorkflowManager
extends java.lang.Object

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)

Constructor Summary

Constructors

Constructor and Description
XmlWorkflowManager()

Method Summary

Methods

Modifier and Type	Method and Description
static WorkspaceItem	abort(Context c, XmlWorkflowItem wi, EPerson e)
static void	alertUsersOnTaskActivation(Context c, XmlWorkflowItem wfi, java.lang.String emailTemplate, java.util.List<EPerson> epa, java.lang.String... arguments)
protected static Item	archive(Context c, XmlWorkflowItem wfi) Commit the contained item to the main archive.
static void	createOwnedTask(Context c, XmlWorkflowItem wi, Step step, WorkflowActionConfig action, EPerson e)
static void	createPoolTasks(Context context, XmlWorkflowItem wi, RoleMembers assignees, Step step, WorkflowActionConfig action)
static void	deleteAllPooledTasks(Context c, XmlWorkflowItem wi)
static void	deleteAllTasks(Context c, XmlWorkflowItem wi) Deletes all tasks from this workflowflowitem
static void	deleteClaimedTask(Context c, XmlWorkflowItem wi, ClaimedTask task)
static void	deletePooledTask(Context c, XmlWorkflowItem wi, PoolTask task)
static WorkflowActionConfig	doState(Context c, EPerson user, javax.servlet.http.HttpServletRequest request, int workflowItemId, Workflow workflow, WorkflowActionConfig currentActionConfig)
static java.lang.String	getEPersonName(EPerson e)
static java.lang.String	getMyDSpaceLink()
protected static void	logWorkflowEvent(Context c, java.lang.String workflowId, java.lang.String previousStepId, java.lang.String previousActionConfigId, XmlWorkflowItem wfi, EPerson actor, Step newStep, WorkflowActionConfig newActionConfig)
static WorkflowActionConfig	processOutcome(Context c, EPerson user, Workflow workflow, Step currentStep, WorkflowActionConfig currentActionConfig, ActionResult currentOutcome, XmlWorkflowItem wfi, boolean enteredNewStep)
static WorkspaceItem	sendWorkflowItemBackSubmission(Context c, XmlWorkflowItem wi, EPerson e, java.lang.String provenance, java.lang.String rejection_message) rejects an item - rejection means undoing a submit - WorkspaceItem is created, and the WorkflowItem is removed, user is emailed rejection_message.
static XmlWorkflowItem	start(Context context, WorkspaceItem wsi)
static XmlWorkflowItem	startWithoutNotify(Context c, WorkspaceItem wsi) startWithoutNotify() starts the workflow normally, but disables notifications (useful for large imports,) for the first workflow step - subsequent notifications happen normally

Methods inherited from class java.lang.Object

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

Constructor Detail

XmlWorkflowManager

public XmlWorkflowManager()

Method Detail

start

public static XmlWorkflowItem start(Context context,
                    WorkspaceItem wsi)
                             throws java.sql.SQLException,
                                    AuthorizeException,
                                    java.io.IOException,
                                    WorkflowConfigurationException,
                                    javax.mail.MessagingException,
                                    WorkflowException

Throws:

java.sql.SQLException

AuthorizeException

java.io.IOException

WorkflowConfigurationException

javax.mail.MessagingException

WorkflowException

startWithoutNotify

public static XmlWorkflowItem startWithoutNotify(Context c,
                                 WorkspaceItem wsi)
                                          throws java.sql.SQLException,
                                                 AuthorizeException,
                                                 java.io.IOException,
                                                 WorkflowException,
                                                 WorkflowConfigurationException,
                                                 javax.mail.MessagingException

startWithoutNotify() starts the workflow normally, but disables notifications (useful for large imports,) for the first workflow step - subsequent notifications happen normally

Parameters:

c -

wsi -

Returns:

a new workflow item wrapping the item removed from the workspace.

Throws:

java.sql.SQLException - passed through

AuthorizeException - passed through.

java.io.IOException - passed through.

WorkflowException - passed through.

WorkflowConfigurationException - passed through.

javax.mail.MessagingException - passed through.

alertUsersOnTaskActivation

public static void alertUsersOnTaskActivation(Context c,
                              XmlWorkflowItem wfi,
                              java.lang.String emailTemplate,
                              java.util.List<EPerson> epa,
                              java.lang.String... arguments)
                                       throws java.io.IOException,
                                              java.sql.SQLException,
                                              javax.mail.MessagingException

Throws:

java.io.IOException

java.sql.SQLException

javax.mail.MessagingException

doState

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

Throws:

java.sql.SQLException

AuthorizeException

java.io.IOException

javax.mail.MessagingException

WorkflowConfigurationException

WorkflowException

processOutcome

public static WorkflowActionConfig processOutcome(Context c,
                                  EPerson user,
                                  Workflow workflow,
                                  Step currentStep,
                                  WorkflowActionConfig currentActionConfig,
                                  ActionResult currentOutcome,
                                  XmlWorkflowItem wfi,
                                  boolean enteredNewStep)
                                           throws java.io.IOException,
                                                  WorkflowConfigurationException,
                                                  AuthorizeException,
                                                  java.sql.SQLException,
                                                  WorkflowException

Throws:

java.io.IOException

WorkflowConfigurationException

AuthorizeException

java.sql.SQLException

WorkflowException

logWorkflowEvent

protected static void logWorkflowEvent(Context c,
                    java.lang.String workflowId,
                    java.lang.String previousStepId,
                    java.lang.String previousActionConfigId,
                    XmlWorkflowItem wfi,
                    EPerson actor,
                    Step newStep,
                    WorkflowActionConfig newActionConfig)
                                throws java.sql.SQLException

Throws:

java.sql.SQLException

archive

protected static Item archive(Context c,
           XmlWorkflowItem wfi)
                       throws java.sql.SQLException,
                              java.io.IOException,
                              AuthorizeException

Commit the contained item to the main archive. The item is associated with the relevant collection, added to the search index, and any other tasks such as assigning dates are performed.

Parameters:

c -

wfi -

Returns:

the fully archived item.

Throws:

java.sql.SQLException - passed through.

java.io.IOException - passed through.

AuthorizeException - passed through.

deleteAllTasks

public static void deleteAllTasks(Context c,
                  XmlWorkflowItem wi)
                           throws java.sql.SQLException,
                                  AuthorizeException

Deletes all tasks from this workflowflowitem

Parameters:

c - the dspace context

wi - the workflow item for whom we are to delete the tasks

Throws:

java.sql.SQLException - ...

AuthorizeException - ...

deleteAllPooledTasks

public static void deleteAllPooledTasks(Context c,
                        XmlWorkflowItem wi)
                                 throws java.sql.SQLException,
                                        AuthorizeException

Throws:

java.sql.SQLException

AuthorizeException

deletePooledTask

public static void deletePooledTask(Context c,
                    XmlWorkflowItem wi,
                    PoolTask task)
                             throws java.sql.SQLException,
                                    AuthorizeException

Throws:

java.sql.SQLException

AuthorizeException

deleteClaimedTask

public static void deleteClaimedTask(Context c,
                     XmlWorkflowItem wi,
                     ClaimedTask task)
                              throws java.sql.SQLException,
                                     AuthorizeException

Throws:

java.sql.SQLException

AuthorizeException

createPoolTasks

public static void createPoolTasks(Context context,
                   XmlWorkflowItem wi,
                   RoleMembers assignees,
                   Step step,
                   WorkflowActionConfig action)
                            throws java.sql.SQLException,
                                   AuthorizeException

Throws:

java.sql.SQLException

AuthorizeException

createOwnedTask

public static void createOwnedTask(Context c,
                   XmlWorkflowItem wi,
                   Step step,
                   WorkflowActionConfig action,
                   EPerson e)
                            throws java.sql.SQLException,
                                   AuthorizeException

Throws:

java.sql.SQLException

AuthorizeException

sendWorkflowItemBackSubmission

public static WorkspaceItem sendWorkflowItemBackSubmission(Context c,
                                           XmlWorkflowItem wi,
                                           EPerson e,
                                           java.lang.String provenance,
                                           java.lang.String rejection_message)
                                                    throws java.sql.SQLException,
                                                           AuthorizeException,
                                                           java.io.IOException

rejects an item - rejection means undoing a submit - WorkspaceItem is created, and the WorkflowItem is removed, user is emailed rejection_message.

Parameters:

c - Context

wi - WorkflowItem to operate on

e - EPerson doing the operation

provenance - the provenance message

rejection_message - message to email to user (if null no email is sent)

Returns:

the workspace item that is created

Throws:

java.io.IOException - ...

java.sql.SQLException - ...

AuthorizeException - ...

abort

public static WorkspaceItem abort(Context c,
                  XmlWorkflowItem wi,
                  EPerson e)
                           throws AuthorizeException,
                                  java.sql.SQLException,
                                  java.io.IOException

Throws:

AuthorizeException

java.sql.SQLException

java.io.IOException

getEPersonName

public static java.lang.String getEPersonName(EPerson e)
                                       throws java.sql.SQLException

Throws:

java.sql.SQLException

getMyDSpaceLink

public static java.lang.String getMyDSpaceLink()