WorkflowService (DSpace Kernel :: API and Implementation 6.0-rc1 API)

All Known Subinterfaces:

BasicWorkflowService, XmlWorkflowService

All Known Implementing Classes:

BasicWorkflowServiceImpl, XmlWorkflowServiceImpl
```
public interface WorkflowService<T extends WorkflowItem>
```
Service interface class for the WorkflowService framework. All WorkflowServices service classes should implement this class since it offers some basic methods which all Workflows are required to have.

Author:

kevinvandevelde at atmire.com

Method Summary

Methods
Modifier and Type	Method and Description
`WorkspaceItem`	`abort(Context c, T wi, EPerson e)` abort() aborts a workflow, completely deleting it (administrator do this) (it will basically do a reject from any state - the item ends up back in the user's PersonalWorkspace
`void`	`addInitialWorkspaceItemPolicies(Context context, WorkspaceItem workspaceItem)`
`Item`	`archive(Context context, T workflowItem)`
`void`	`deleteCollection(Context context, Collection collection)`
`List<String>`	`getEPersonDeleteConstraints(Context context, EPerson ePerson)`
`List<String>`	`getFlywayMigrationLocations()`
`String`	`getMyDSpaceLink()`
`Group`	`getWorkflowRoleGroup(Context context, Collection collection, String roleName, Group roleGroup)`
`WorkspaceItem`	`sendWorkflowItemBackSubmission(Context c, T workflowItem, EPerson e, String provenance, String rejection_message)`
`T`	`start(Context context, WorkspaceItem wsi)` startWorkflow() begins a workflow - in a single transaction do away with the PersonalWorkspace entry and turn it into a WorkflowItem.
`T`	`startWithoutNotify(Context c, WorkspaceItem wsi)` startWithoutNotify() starts the workflow normally, but disables notifications (useful for large imports,) for the first workflow step - subsequent notifications happen normally

Method Detail

addInitialWorkspaceItemPolicies

void addInitialWorkspaceItemPolicies(Context context,
                                   WorkspaceItem workspaceItem)
                                     throws SQLException,
                                            AuthorizeException

Throws:: SQLException; AuthorizeException

start

T start(Context context,
      WorkspaceItem wsi)
                             throws SQLException,
                                    AuthorizeException,
                                    IOException,
                                    WorkflowException

startWorkflow() begins a workflow - in a single transaction do away with the PersonalWorkspace entry and turn it into a WorkflowItem.

Parameters:: context - Context; wsi - The WorkspaceItem to convert to a workflow item
Returns:: The resulting workflow item
Throws:: SQLException; AuthorizeException; IOException; WorkflowException

startWithoutNotify

T startWithoutNotify(Context c,
                   WorkspaceItem wsi)
                                          throws SQLException,
                                                 AuthorizeException,
                                                 IOException,
                                                 WorkflowException

startWithoutNotify() starts the workflow normally, but disables notifications (useful for large imports,) for the first workflow step - subsequent notifications happen normally

Throws:: SQLException; AuthorizeException; IOException; WorkflowException

abort

WorkspaceItem abort(Context c,
                  T wi,
                  EPerson e)
                    throws SQLException,
                           AuthorizeException,
                           IOException

abort() aborts a workflow, completely deleting it (administrator do this) (it will basically do a reject from any state - the item ends up back in the user's PersonalWorkspace

Parameters:: c - Context; wi - WorkflowItem to operate on; e - EPerson doing the operation
Throws:: SQLException; AuthorizeException; IOException

sendWorkflowItemBackSubmission

WorkspaceItem sendWorkflowItemBackSubmission(Context c,
                                           T workflowItem,
                                           EPerson e,
                                           String provenance,
                                           String rejection_message)
                                             throws SQLException,
                                                    AuthorizeException,
                                                    IOException

Throws:: SQLException; AuthorizeException; IOException

getMyDSpaceLink
```
String getMyDSpaceLink()
```

deleteCollection

void deleteCollection(Context context,
                    Collection collection)
                      throws SQLException,
                             IOException,
                             AuthorizeException

Throws:: SQLException; IOException; AuthorizeException

getEPersonDeleteConstraints

List<String> getEPersonDeleteConstraints(Context context,
                                       EPerson ePerson)
                                         throws SQLException

Throws:: SQLException

getWorkflowRoleGroup

Group getWorkflowRoleGroup(Context context,
                         Collection collection,
                         String roleName,
                         Group roleGroup)
                           throws SQLException,
                                  IOException,
                                  WorkflowConfigurationException,
                                  AuthorizeException,
                                  WorkflowException

Throws:: SQLException; IOException; WorkflowConfigurationException; AuthorizeException; WorkflowException

getFlywayMigrationLocations

List<String> getFlywayMigrationLocations()

Interface WorkflowService<T extends WorkflowItem>