org.dspace.workflowbasic.service

Interface BasicWorkflowService

All Superinterfaces:

WorkflowService<BasicWorkflowItem>

All Known Implementing Classes:

BasicWorkflowServiceImpl

public interface BasicWorkflowService
extends WorkflowService<BasicWorkflowItem>

Workflow state machine Notes: Determining item status from the database: When an item has not been submitted yet, it is in the user's personal workspace (there is a row in PersonalWorkspace pointing to it.) When an item is submitted and is somewhere in a workflow, it has a row in the WorkflowItem table pointing to it. The state of the workflow can be determined by looking at WorkflowItem.getState() When a submission is complete, the WorkflowItem pointing to the item is destroyed and the archive() method is called, which hooks the item up to the archive. Notification: When an item enters a state that requires notification, (WFSTATE_STEP1POOL, WFSTATE_STEP2POOL, WFSTATE_STEP3POOL,) the workflow needs to notify the appropriate groups that they have a pending task to claim. Revealing lists of approvers, editors, and reviewers. A method could be added to do this, but it isn't strictly necessary. (say public List getStateEPeople( WorkflowItem wi, int state ) could return people affected by the item's current state.

Field Summary

Fields

Modifier and Type	Field and Description
static int	WFSTATE_ARCHIVE
static int	WFSTATE_STEP1
static int	WFSTATE_STEP1POOL
static int	WFSTATE_STEP2
static int	WFSTATE_STEP2POOL
static int	WFSTATE_STEP3
static int	WFSTATE_STEP3POOL
static int	WFSTATE_SUBMIT

Method Summary

Modifier and Type	Method and Description
void	advance(Context context, BasicWorkflowItem workflowItem, EPerson e) advance() sends an item forward in the workflow (reviewers, approvers, and editors all do an 'approve' to move the item forward) if the item arrives at the submit state, then remove the WorkflowItem and call the archive() method to put it in the archive, and email notify the submitter of a successful submission
boolean	advance(Context context, BasicWorkflowItem workflowItem, EPerson e, boolean curate, boolean record) advance() sends an item forward in the workflow (reviewers, approvers, and editors all do an 'approve' to move the item forward) if the item arrives at the submit state, then remove the WorkflowItem and call the archive() method to put it in the archive, and email notify the submitter of a successful submission
void	claim(Context context, BasicWorkflowItem workflowItem, EPerson e) claim() claims a workflow task for an EPerson
String	getItemTitle(BasicWorkflowItem wi) get the title of the item in this workflow
List<BasicWorkflowItem>	getOwnedTasks(Context context, EPerson e) getOwnedTasks() returns a List of WorkflowItems containing the tasks claimed and owned by an EPerson.
List<BasicWorkflowItem>	getPooledTasks(Context context, EPerson e) getPooledTasks() returns a List of WorkflowItems an EPerson could claim (as a reviewer, etc.) for display on a user's MyDSpace page.
String	getSubmitterName(BasicWorkflowItem wi) get the name of the eperson who started this workflow
int	getWorkflowID(String state) Translate symbolic name of workflow state into number.
String	getWorkflowText(int state) Get the text representing the given workflow state
void	notifyOfCuration(Context c, BasicWorkflowItem wi, List<EPerson> ePeople, String taskName, String action, String message)
void	unclaim(Context context, BasicWorkflowItem workflowItem, EPerson e) unclaim() returns an owned task/item to the pool

Methods inherited from interface org.dspace.workflow.WorkflowService

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

Field Detail

WFSTATE_SUBMIT

static final int WFSTATE_SUBMIT

See Also:

Constant Field Values

WFSTATE_STEP1POOL

static final int WFSTATE_STEP1POOL

See Also:

Constant Field Values

WFSTATE_STEP1

static final int WFSTATE_STEP1

See Also:

Constant Field Values

WFSTATE_STEP2POOL

static final int WFSTATE_STEP2POOL

See Also:

Constant Field Values

WFSTATE_STEP2

static final int WFSTATE_STEP2

See Also:

Constant Field Values

WFSTATE_STEP3POOL

static final int WFSTATE_STEP3POOL

See Also:

Constant Field Values

WFSTATE_STEP3

static final int WFSTATE_STEP3

See Also:

Constant Field Values

WFSTATE_ARCHIVE

static final int WFSTATE_ARCHIVE

See Also:

Constant Field Values

Method Detail

getWorkflowID

int getWorkflowID(String state)

Translate symbolic name of workflow state into number. The name is case-insensitive. Returns -1 when name cannot be matched.

Parameters:

state - symbolic name of workflow state, must be one of the elements of workflowText array.

Returns:

numeric workflow state or -1 for error.

getOwnedTasks

List<BasicWorkflowItem> getOwnedTasks(Context context,
                                      EPerson e)
                               throws SQLException

getOwnedTasks() returns a List of WorkflowItems containing the tasks claimed and owned by an EPerson. The GUI displays this info on the MyDSpace page.

Parameters:

e - The EPerson we want to fetch owned tasks for.

Throws:

SQLException

getPooledTasks

List<BasicWorkflowItem> getPooledTasks(Context context,
                                       EPerson e)
                                throws SQLException

getPooledTasks() returns a List of WorkflowItems an EPerson could claim (as a reviewer, etc.) for display on a user's MyDSpace page.

Parameters:

e - The Eperson we want to fetch the pooled tasks for.

Throws:

SQLException

claim

void claim(Context context,
           BasicWorkflowItem workflowItem,
           EPerson e)
    throws SQLException,
           IOException,
           AuthorizeException

claim() claims a workflow task for an EPerson

Parameters:

workflowItem - WorkflowItem to do the claim on

e - The EPerson doing the claim

Throws:

SQLException

IOException

AuthorizeException

advance

void advance(Context context,
             BasicWorkflowItem workflowItem,
             EPerson e)
      throws SQLException,
             IOException,
             AuthorizeException

advance() sends an item forward in the workflow (reviewers, approvers, and editors all do an 'approve' to move the item forward) if the item arrives at the submit state, then remove the WorkflowItem and call the archive() method to put it in the archive, and email notify the submitter of a successful submission

Parameters:

context - Context

workflowItem - WorkflowItem do do the approval on

e - EPerson doing the approval

Throws:

SQLException

IOException

AuthorizeException

advance

boolean advance(Context context,
                BasicWorkflowItem workflowItem,
                EPerson e,
                boolean curate,
                boolean record)
         throws SQLException,
                IOException,
                AuthorizeException

advance() sends an item forward in the workflow (reviewers, approvers, and editors all do an 'approve' to move the item forward) if the item arrives at the submit state, then remove the WorkflowItem and call the archive() method to put it in the archive, and email notify the submitter of a successful submission

Parameters:

context - Context

workflowItem - WorkflowItem do do the approval on

e - EPerson doing the approval

curate - boolean indicating whether curation tasks should be done

record - boolean indicating whether to record action

Throws:

SQLException

IOException

AuthorizeException

unclaim

void unclaim(Context context,
             BasicWorkflowItem workflowItem,
             EPerson e)
      throws SQLException,
             IOException,
             AuthorizeException

unclaim() returns an owned task/item to the pool

Parameters:

context - Context

workflowItem - WorkflowItem to operate on

e - EPerson doing the operation

Throws:

SQLException

IOException

AuthorizeException

getWorkflowText

String getWorkflowText(int state)

Get the text representing the given workflow state

Parameters:

state - the workflow state

Returns:

the text representation

notifyOfCuration

void notifyOfCuration(Context c,
                      BasicWorkflowItem wi,
                      List<EPerson> ePeople,
                      String taskName,
                      String action,
                      String message)
               throws SQLException,
                      IOException

Throws:

SQLException

IOException

getItemTitle

String getItemTitle(BasicWorkflowItem wi)
             throws SQLException

get the title of the item in this workflow

Parameters:

wi - the workflow item object

Throws:

SQLException

getSubmitterName

String getSubmitterName(BasicWorkflowItem wi)
                 throws SQLException

get the name of the eperson who started this workflow

Parameters:

wi - the workflow item

Throws:

SQLException