Package org.dspace.xmlworkflow.service

Interface WorkflowRequirementsService

All Known Implementing Classes:

WorkflowRequirementsServiceImpl

public interface WorkflowRequirementsService

A class that contains utility methods related to the workflow. The adding/removing of claimed users, and ensuring that if multiple users have to perform these steps that a count is kept so that no more than the allowed user count are allowed to perform their actions.

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

Modifier and Type	Field	Description
static final String	WORKFLOW_SCHEMA

Method Summary

Modifier and Type	Method	Description
void	addClaimedUser(Context context, XmlWorkflowItem wfi, Step step, EPerson user)	Adds a claimed user in the metadata.
void	addFinishedUser(Context context, XmlWorkflowItem wfi, EPerson user)	Adds a finished user in the metadata.
void	clearInProgressUsers(Context context, XmlWorkflowItem wfi)
void	removeClaimedUser(Context context, XmlWorkflowItem wfi, EPerson user, String stepID)

Field Details

WORKFLOW_SCHEMA

static final String WORKFLOW_SCHEMA

See Also:

• Constant Field Values

Method Details

addClaimedUser

void addClaimedUser(Context context,
 XmlWorkflowItem wfi,
 Step step,
 EPerson user)
             throws SQLException,
AuthorizeException,
IOException

Adds a claimed user in the metadata. If enough users have claimed this task (claimed or finished) to meet the required number, the pooled tasks will be deleted.

Parameters:

context - the dspace context

wfi - the workflow item

step - the step for which we are accepting

user - the current user

Throws:

SQLException - ...

AuthorizeException - ...

IOException - ...

removeClaimedUser

void removeClaimedUser(Context context,
 XmlWorkflowItem wfi,
 EPerson user,
 String stepID)
                throws SQLException,
IOException,
WorkflowConfigurationException,
AuthorizeException

Throws:

SQLException

IOException

WorkflowConfigurationException

AuthorizeException

addFinishedUser

void addFinishedUser(Context context,
 XmlWorkflowItem wfi,
 EPerson user)
              throws AuthorizeException,
SQLException

Adds a finished user in the metadata. This method will also remove the user from the in-progress metadata.

Parameters:

context - the dspace context

wfi - the workflow item

user - the current user

Throws:

AuthorizeException - ...

SQLException - ...

clearInProgressUsers

void clearInProgressUsers(Context context,
 XmlWorkflowItem wfi)
                   throws AuthorizeException,
SQLException

Throws:

AuthorizeException

SQLException