Package org.dspace.xmlworkflow

Class WorkflowRequirementsServiceImpl

java.lang.Object

org.dspace.xmlworkflow.WorkflowRequirementsServiceImpl

All Implemented Interfaces:

WorkflowRequirementsService

public class WorkflowRequirementsServiceImpl
extends Object
implements WorkflowRequirementsService

A class that contains utililty methods related to the workflow The adding/removing from claimed users and ensuring that if multiple users have to perform these steps that a count is kept so that no more then 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
protected InProgressUserService	inProgressUserService
protected ItemService	itemService
protected PoolTaskService	poolTaskService
protected XmlWorkflowFactory	workflowFactory
protected XmlWorkflowItemService	xmlWorkflowItemService
protected XmlWorkflowService	xmlWorkflowService

Fields inherited from interface org.dspace.xmlworkflow.service.WorkflowRequirementsService

WORKFLOW_SCHEMA

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	WorkflowRequirementsServiceImpl()

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 c, XmlWorkflowItem wfi, EPerson user)	Adds a finished user in the metadata.
void	clearInProgressUsers(Context c, XmlWorkflowItem wfi)
void	removeClaimedUser(Context context, XmlWorkflowItem wfi, EPerson user, String stepID)

Methods inherited from class java.lang.Object

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

Field Detail

inProgressUserService

@Autowired(required=true)
protected InProgressUserService inProgressUserService

itemService

@Autowired(required=true)
protected ItemService itemService

poolTaskService

@Autowired(required=true)
protected PoolTaskService poolTaskService

workflowFactory

@Autowired(required=true)
protected XmlWorkflowFactory workflowFactory

xmlWorkflowItemService

@Autowired(required=true)
protected XmlWorkflowItemService xmlWorkflowItemService

xmlWorkflowService

@Autowired(required=true)
protected XmlWorkflowService xmlWorkflowService

Constructor Detail

WorkflowRequirementsServiceImpl

protected WorkflowRequirementsServiceImpl()

Method Detail

addClaimedUser

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

Description copied from interface: WorkflowRequirementsService

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.

Specified by:

addClaimedUser in interface WorkflowRequirementsService

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

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

Specified by:

removeClaimedUser in interface WorkflowRequirementsService

Throws:

SQLException

IOException

WorkflowConfigurationException

AuthorizeException

addFinishedUser

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

Description copied from interface: WorkflowRequirementsService

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

Specified by:

addFinishedUser in interface WorkflowRequirementsService

Parameters:

c - the dspace context

wfi - the workflow item

user - the current user

Throws:

AuthorizeException - ...

SQLException - ...

clearInProgressUsers

public void clearInProgressUsers(Context c,
                                 XmlWorkflowItem wfi)
                          throws AuthorizeException,
                                 SQLException

Specified by:

clearInProgressUsers in interface WorkflowRequirementsService

Throws:

AuthorizeException

SQLException