Package org.dspace.xmlworkflow

An Item submission begins as a WorkspaceItem in some user's workspace. The WorkspaceItem wraps an uninstalled Item while it is in the user's workspace.

A WorkspaceItem enters a workflow by being presented to WorkflowService.start(org.dspace.core.Context, org.dspace.content.WorkspaceItem). This causes the wrapped Item to be unwrapped and re-wrapped into a new WorkflowItem, and links the WorkflowItem to objects which represent its state of progress through the workflow of its owning Collection. This unwrapping/re-wrapping removes the Item from the user's workspace and places it into the target Collection's workflow.

The WorkflowItem proceeds through a sequence of "steps". Each step is configured with "actions" and a Role which is to carry out the actions. A Role is configured with lists of Groups and EPersons who will be notified, when the item has entered the step, that there is a review task awaiting them.

When a WorkflowItem enters a Step, it can be acted on first by one or more configured Curation Tasks. See the workflow curation service.

An Item which has completed all "steps" in the target Collection's workflow is removed from the workflow and installed in the archive.

Class Summary

Class	Description
Role	The role that is responsible for a certain step.
RoleMembers	The members from a role, can either contains a list of epersons or groups
WorkflowRequirementsServiceImpl	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
WorkflowUtils	Utility methods for the xml workflow
XmlWorkflowFactoryImpl	This is injected with the external workflow configuration and is used to retrieve information about the workflow: the workflow for a certain collection collections mapped to a certain workflow collections not mapped to any workflow configured workflows and the default workflow workflow action by name
XmlWorkflowServiceImpl	When an item is submitted and is somewhere in a workflow, it has a row in the cwf_workflowitem table pointing to it.

Enum Summary

Enum	Description
Role.Scope

Exception Summary

Exception	Description
WorkflowConfigurationException	Exception for problems with the configuration XML.