Package org.dspace.curate

Class WorkflowCuratorServiceImpl

java.lang.Object

org.dspace.curate.WorkflowCuratorServiceImpl

All Implemented Interfaces:

WorkflowCuratorService

public class WorkflowCuratorServiceImpl
extends Object
implements WorkflowCuratorService

WorkflowCurator manages interactions between curation and workflow. Specifically, it is invoked in WorkflowManager to allow the performance of curation tasks during workflow.

Author:

richardrodgers

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected class	WorkflowCuratorServiceImpl.FlowStep
protected class	WorkflowCuratorServiceImpl.Task
protected class	WorkflowCuratorServiceImpl.TaskSet

Field Summary

Fields

Modifier and Type	Field	Description
protected BasicWorkflowItemService	basicWorkflowItemService
protected BasicWorkflowService	basicWorkflowService
protected CollectionService	collectionService
protected ConfigurationService	configurationService
protected EPersonService	ePersonService
protected String[]	flowSteps
protected GroupService	groupService
protected Map<String,WorkflowCuratorServiceImpl.TaskSet>	tsMap
protected WorkflowServiceFactory	workflowServiceFactory

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	WorkflowCuratorServiceImpl()

Method Summary

Modifier and Type	Method	Description
boolean	curate(Curator curator, Context c, String wfId)	Determines and executes curation of a Workflow item.
boolean	curate(Curator curator, Context c, BasicWorkflowItem wfi)	Determines and executes curation of a Workflow item.
boolean	doCuration(Context c, BasicWorkflowItem wfi)	Determines and executes curation on a Workflow item.
protected WorkflowCuratorServiceImpl.FlowStep	getFlowStep(BasicWorkflowItem wfi)
void	init()	Initialize the bean (after dependency injection has already taken place).
protected void	loadTaskConfig(File cfgFile)
boolean	needsCuration(BasicWorkflowItem wfi)
protected void	notifyContacts(Context c, BasicWorkflowItem wfi, WorkflowCuratorServiceImpl.Task task, String status, String action, String message)
protected List<EPerson>	resolveContacts(Context c, List<String> contacts, BasicWorkflowItem wfi)
protected int	state2step(int state)
protected int	stepName2step(String name)

Methods inherited from class java.lang.Object

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

Field Detail

tsMap

protected Map<String,WorkflowCuratorServiceImpl.TaskSet> tsMap

flowSteps

protected final String[] flowSteps

collectionService

@Autowired(required=true)
protected CollectionService collectionService

ePersonService

@Autowired(required=true)
protected EPersonService ePersonService

groupService

@Autowired(required=true)
protected GroupService groupService

basicWorkflowItemService

protected BasicWorkflowItemService basicWorkflowItemService

basicWorkflowService

protected BasicWorkflowService basicWorkflowService

workflowServiceFactory

@Autowired(required=true)
protected WorkflowServiceFactory workflowServiceFactory

configurationService

@Autowired(required=true)
protected ConfigurationService configurationService

Constructor Detail

WorkflowCuratorServiceImpl

protected WorkflowCuratorServiceImpl()

Method Detail

init

public void init()
          throws Exception

Initialize the bean (after dependency injection has already taken place). Ensures the configurationService is injected, so that we can read the settings from configuration Called by "init-method" in Spring config.

Throws:

Exception - ...

needsCuration

public boolean needsCuration(BasicWorkflowItem wfi)

Specified by:

needsCuration in interface WorkflowCuratorService

doCuration

public boolean doCuration(Context c,
                          BasicWorkflowItem wfi)
                   throws AuthorizeException,
                          IOException,
                          SQLException

Description copied from interface: WorkflowCuratorService

Determines and executes curation on a Workflow item.

Specified by:

doCuration in interface WorkflowCuratorService

Parameters:

c - the context

wfi - the workflow item

Returns:

true if curation was completed or not required, false if tasks were queued for later completion, or item was rejected

Throws:

AuthorizeException - if authorization error

IOException - if IO error

SQLException - if database error

curate

public boolean curate(Curator curator,
                      Context c,
                      String wfId)
               throws AuthorizeException,
                      IOException,
                      SQLException

Description copied from interface: WorkflowCuratorService

Determines and executes curation of a Workflow item.

Specified by:

curate in interface WorkflowCuratorService

Parameters:

curator - the Curator object

c - the user context

wfId - the workflow id

Returns:

true if curation was completed or not required, false if no workflow item found for id or item was rejected

Throws:

AuthorizeException - if authorization error

IOException - if IO error

SQLException - if database error

curate

public boolean curate(Curator curator,
                      Context c,
                      BasicWorkflowItem wfi)
               throws AuthorizeException,
                      IOException,
                      SQLException

Description copied from interface: WorkflowCuratorService

Determines and executes curation of a Workflow item.

Specified by:

curate in interface WorkflowCuratorService

Parameters:

curator - the Curator object

c - the user context

wfi - the workflow item

Returns:

true if curation was completed or not required, false if item was rejected

Throws:

AuthorizeException - if authorization error

IOException - if IO error

SQLException - if database error

notifyContacts

protected void notifyContacts(Context c,
                              BasicWorkflowItem wfi,
                              WorkflowCuratorServiceImpl.Task task,
                              String status,
                              String action,
                              String message)
                       throws AuthorizeException,
                              IOException,
                              SQLException

Throws:

AuthorizeException

IOException

SQLException

resolveContacts

protected List<EPerson> resolveContacts(Context c,
                                        List<String> contacts,
                                        BasicWorkflowItem wfi)
                                 throws AuthorizeException,
                                        IOException,
                                        SQLException

Throws:

AuthorizeException

IOException

SQLException

getFlowStep

protected WorkflowCuratorServiceImpl.FlowStep getFlowStep(BasicWorkflowItem wfi)

state2step

protected int state2step(int state)

stepName2step

protected int stepName2step(String name)

loadTaskConfig

protected void loadTaskConfig(File cfgFile)
                       throws IOException

Throws:

IOException