BasicWorkflowServiceImpl (DSpace Kernel :: API and Implementation 6.1 API)

java.lang.Object
- org.dspace.workflowbasic.BasicWorkflowServiceImpl

All Implemented Interfaces:: WorkflowService<BasicWorkflowItem>, BasicWorkflowService

public class BasicWorkflowServiceImpl
extends Object
implements BasicWorkflowService

Field Summary

Fields
Modifier and Type	Field and Description
`protected AuthorizeService`	`authorizeService`
`protected CollectionService`	`collectionService`
`protected ConfigurationService`	`configurationService`
`protected GroupService`	`groupService`
`protected HandleService`	`handleService`
`protected InstallItemService`	`installItemService`
`protected ItemService`	`itemService`
`protected Map<UUID,Boolean>`	`noEMail`
`protected TaskListItemService`	`taskListItemService`
`protected WorkflowCuratorService`	`workflowCuratorService`
`protected BasicWorkflowItemService`	`workflowItemService`
`protected String[]`	`workflowText` Symbolic names of workflow steps.
`protected WorkspaceItemService`	`workspaceItemService`

Fields inherited from interface org.dspace.workflowbasic.service.BasicWorkflowService
WFSTATE_ARCHIVE, WFSTATE_STEP1, WFSTATE_STEP1POOL, WFSTATE_STEP2, WFSTATE_STEP2POOL, WFSTATE_STEP3, WFSTATE_STEP3POOL, WFSTATE_SUBMIT

Constructor Summary

Constructors
Modifier Constructor and Description

protected BasicWorkflowServiceImpl()

Constructors
Modifier	Constructor and Description
`protected`	`BasicWorkflowServiceImpl()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`WorkspaceItem`	`abort(Context context, BasicWorkflowItem workflowItem, 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`	`advance(Context context, BasicWorkflowItem workflowItem, EPerson e)` advance() sends an item forward in the workflow (reviewers, approvers, and editors all do an 'approve' to move the item forward) if the item arrives at the submit state, then remove the WorkflowItem and call the archive() method to put it in the archive, and email notify the submitter of a successful submission
`boolean`	`advance(Context context, BasicWorkflowItem workflowItem, EPerson e, boolean curate, boolean record)` advance() sends an item forward in the workflow (reviewers, approvers, and editors all do an 'approve' to move the item forward) if the item arrives at the submit state, then remove the WorkflowItem and call the archive() method to put it in the archive, and email notify the submitter of a successful submission
`protected Item`	`archive(Context context, BasicWorkflowItem workflowItem)` Commit the contained item to the main archive.
`protected void`	`assignToReviewer(Context context, BasicWorkflowItem workflowItem, int step, EPerson newowner)` Helper method to take an item out of the pool, to assign it to a reviewer and to deal with reviewer policies.
`void`	`claim(Context context, BasicWorkflowItem workflowItem, EPerson e)` claim() claims a workflow task for an EPerson
`protected void`	`createTasks(Context c, BasicWorkflowItem wi, List<EPerson> epa)`
`void`	`deleteCollection(Context context, Collection collection)`
`protected boolean`	`doState(Context context, BasicWorkflowItem workflowItem, int newstate, EPerson newowner)`
`List<String>`	`getEPersonDeleteConstraints(Context context, EPerson ePerson)`
`protected String`	`getEPersonName(EPerson e)`
`List<String>`	`getFlywayMigrationLocations()`
`String`	`getItemTitle(BasicWorkflowItem wi)` get the title of the item in this workflow
`String`	`getMyDSpaceLink()`
`List<BasicWorkflowItem>`	`getOwnedTasks(Context context, EPerson e)` getOwnedTasks() returns a List of WorkflowItems containing the tasks claimed and owned by an EPerson.
`List<BasicWorkflowItem>`	`getPooledTasks(Context context, EPerson e)` getPooledTasks() returns a List of WorkflowItems an EPerson could claim (as a reviewer, etc.) for display on a user's MyDSpace page.
`String`	`getSubmitterName(BasicWorkflowItem wi)` get the name of the eperson who started this workflow
`int`	`getWorkflowID(String state)` Translate symbolic name of workflow state into number.
`Group`	`getWorkflowRoleGroup(Context context, Collection collection, String roleName, Group roleGroup)`
`String`	`getWorkflowText(int state)` Get the text representing the given workflow state
`protected void`	`grantReviewerPolicies(Context context, BasicWorkflowItem wfi, EPerson reviewer)` This methods grants the appropriate permissions to reviewers so that they can read and edit metadata and read files and edit files if allowed by configuration.
`protected void`	`logWorkflowEvent(Context context, Item item, BasicWorkflowItem workflowItem, EPerson actor, int newstate, EPerson newOwner, Collection mycollection, int oldState, Group newOwnerGroup)`
`protected void`	`notifyGroupOfTask(Context c, BasicWorkflowItem wi, Group mygroup, List<EPerson> epa)`
`protected void`	`notifyOfArchive(Context context, Item item, Collection coll)` notify the submitter that the item is archived
`void`	`notifyOfCuration(Context c, BasicWorkflowItem wi, List<EPerson> ePeople, String taskName, String action, String message)`
`protected void`	`notifyOfReject(Context context, BasicWorkflowItem workflowItem, EPerson e, String reason)`
`protected boolean`	`pool(Context context, BasicWorkflowItem workflowItem, int step)` Helper method that manages state, policies, owner, notifies, tasklistitems and so on whenever an WorkflowItem should be added to a workflow step pool.
`protected void`	`recordApproval(Context context, BasicWorkflowItem workflowItem, EPerson e)`
`protected void`	`recordStart(Context context, Item myitem)`
`protected WorkspaceItem`	`returnToWorkspace(Context c, BasicWorkflowItem wfi)` Return the workflow item to the workspace of the submitter.
`protected void`	`revokeReviewerPolicies(Context context, Item item)` This methods revokes any permission granted by the basic workflow systems on the item specified as attribute.
`WorkspaceItem`	`sendWorkflowItemBackSubmission(Context context, BasicWorkflowItem workflowItem, EPerson ePerson, String provenancePrefix, String rejection_message)`
`BasicWorkflowItem`	`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.
`BasicWorkflowItem`	`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
`void`	`unclaim(Context context, BasicWorkflowItem workflowItem, EPerson e)` unclaim() returns an owned task/item to the pool

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

authorizeService

@Autowired(required=true)
protected AuthorizeService authorizeService

collectionService

@Autowired(required=true)
protected CollectionService collectionService

groupService

@Autowired(required=true)
protected GroupService groupService

handleService

@Autowired(required=true)
protected HandleService handleService

installItemService

@Autowired(required=true)
protected InstallItemService installItemService

itemService

@Autowired(required=true)
protected ItemService itemService

taskListItemService

@Autowired(required=true)
protected TaskListItemService taskListItemService

workflowCuratorService

@Autowired(required=true)
protected WorkflowCuratorService workflowCuratorService

workflowItemService

@Autowired(required=true)
protected BasicWorkflowItemService workflowItemService

workspaceItemService

@Autowired(required=true)
protected WorkspaceItemService workspaceItemService

configurationService

@Autowired(required=true)
protected ConfigurationService configurationService

workflowText
```
protected final String[] workflowText
```
Symbolic names of workflow steps.

noEMail
```
protected Map<UUID,Boolean> noEMail
```

Constructor Detail
- BasicWorkflowServiceImpl
```
protected BasicWorkflowServiceImpl()
```

Method Detail

getWorkflowID
```
public int getWorkflowID(String state)
```
Description copied from interface: BasicWorkflowService

Translate symbolic name of workflow state into number. The name is case-insensitive. Returns -1 when name cannot be matched.

Specified by:

getWorkflowID in interface BasicWorkflowService

Parameters:

state - symbolic name of workflow state, must be one of the elements of workflowText array.

Returns:

numeric workflow state or -1 for error.

grantReviewerPolicies
```
protected void grantReviewerPolicies(Context context,
                                     BasicWorkflowItem wfi,
                                     EPerson reviewer)
                              throws SQLException,
                                     AuthorizeException
```
This methods grants the appropriate permissions to reviewers so that they can read and edit metadata and read files and edit files if allowed by configuration. In most cases this method must be called within a try-finally-block that temporary disables the authentication system. This is not done by this method as it should be done carefully and only in contexts in which granting the permissions is authorized by some previous checks.

Parameters:

context -

wfi - While all policies are granted on item, bundle or bitstream level, this method takes an workflowitem for convenience and uses wfi.getItem() to get the actual item.

reviewer - EPerson to grant the rights to.

Throws:

SQLException

AuthorizeException

revokeReviewerPolicies
```
protected void revokeReviewerPolicies(Context context,
                                      Item item)
                               throws SQLException,
                                      AuthorizeException
```
This methods revokes any permission granted by the basic workflow systems on the item specified as attribute. At time of writing this method these permissions will all be granted by grantReviewerPolicies(org.dspace.core.Context, org.dspace.workflowbasic.BasicWorkflowItem, org.dspace.eperson.EPerson). In most cases this method must be called within a try-finally-block that temporary disables the authentication system. This is not done by this method as it should be done carefully and only in contexts in which revoking the permissions is authorized by some previous checks.

Parameters:

context -

item -

Throws:

SQLException

AuthorizeException

start
```
public BasicWorkflowItem start(Context context,
                               WorkspaceItem wsi)
                        throws SQLException,
                               AuthorizeException,
                               IOException
```
Description copied from interface: WorkflowService

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

Specified by:

start in interface WorkflowService<BasicWorkflowItem>

Parameters:

context - Context

wsi - The WorkspaceItem to convert to a workflow item

Returns:

The resulting workflow item

Throws:

SQLException

AuthorizeException

IOException

startWithoutNotify

public BasicWorkflowItem startWithoutNotify(Context c,
                                            WorkspaceItem wsi)
                                     throws SQLException,
                                            AuthorizeException,
                                            IOException

Description copied from interface: WorkflowService

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

Specified by:: startWithoutNotify in interface WorkflowService<BasicWorkflowItem>
Throws:: SQLException; AuthorizeException; IOException

getOwnedTasks
```
public List<BasicWorkflowItem> getOwnedTasks(Context context,
                                             EPerson e)
                                      throws SQLException
```
Description copied from interface: BasicWorkflowService

getOwnedTasks() returns a List of WorkflowItems containing the tasks claimed and owned by an EPerson. The GUI displays this info on the MyDSpace page.

Specified by:

getOwnedTasks in interface BasicWorkflowService

e - The EPerson we want to fetch owned tasks for.

Throws:

SQLException

getPooledTasks
```
public List<BasicWorkflowItem> getPooledTasks(Context context,
                                              EPerson e)
                                       throws SQLException
```
Description copied from interface: BasicWorkflowService

getPooledTasks() returns a List of WorkflowItems an EPerson could claim (as a reviewer, etc.) for display on a user's MyDSpace page.

Specified by:

getPooledTasks in interface BasicWorkflowService

e - The Eperson we want to fetch the pooled tasks for.

Throws:

SQLException

claim

public void claim(Context context,
                  BasicWorkflowItem workflowItem,
                  EPerson e)
           throws SQLException,
                  IOException,
                  AuthorizeException

Description copied from interface: BasicWorkflowService

claim() claims a workflow task for an EPerson

Specified by:: claim in interface BasicWorkflowService; workflowItem - WorkflowItem to do the claim on; e - The EPerson doing the claim
Throws:: SQLException; IOException; AuthorizeException

advance
```
public void advance(Context context,
                    BasicWorkflowItem workflowItem,
                    EPerson e)
             throws SQLException,
                    IOException,
                    AuthorizeException
```
Description copied from interface: BasicWorkflowService

advance() sends an item forward in the workflow (reviewers, approvers, and editors all do an 'approve' to move the item forward) if the item arrives at the submit state, then remove the WorkflowItem and call the archive() method to put it in the archive, and email notify the submitter of a successful submission

Specified by:

advance in interface BasicWorkflowService

Parameters:

context - Context

workflowItem - WorkflowItem do do the approval on

e - EPerson doing the approval

Throws:

SQLException

IOException

AuthorizeException

advance
```
public boolean advance(Context context,
                       BasicWorkflowItem workflowItem,
                       EPerson e,
                       boolean curate,
                       boolean record)
                throws SQLException,
                       IOException,
                       AuthorizeException
```
Description copied from interface: BasicWorkflowService

advance() sends an item forward in the workflow (reviewers, approvers, and editors all do an 'approve' to move the item forward) if the item arrives at the submit state, then remove the WorkflowItem and call the archive() method to put it in the archive, and email notify the submitter of a successful submission

Specified by:

advance in interface BasicWorkflowService

Parameters:

context - Context

workflowItem - WorkflowItem do do the approval on

e - EPerson doing the approval

curate - boolean indicating whether curation tasks should be done

record - boolean indicating whether to record action

Throws:

SQLException

IOException

AuthorizeException

unclaim

public void unclaim(Context context,
                    BasicWorkflowItem workflowItem,
                    EPerson e)
             throws SQLException,
                    IOException,
                    AuthorizeException

Description copied from interface: BasicWorkflowService

unclaim() returns an owned task/item to the pool

Specified by:: unclaim in interface BasicWorkflowService
Parameters:: context - Context; workflowItem - WorkflowItem to operate on; e - EPerson doing the operation
Throws:: SQLException; IOException; AuthorizeException

abort
```
public WorkspaceItem abort(Context context,
                           BasicWorkflowItem workflowItem,
                           EPerson e)
                    throws SQLException,
                           AuthorizeException,
                           IOException
```
Description copied from interface: WorkflowService

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

Specified by:

abort in interface WorkflowService<BasicWorkflowItem>

Parameters:

context - Context

workflowItem - WorkflowItem to operate on

e - EPerson doing the operation

Throws:

SQLException

AuthorizeException

IOException

doState

protected boolean doState(Context context,
                          BasicWorkflowItem workflowItem,
                          int newstate,
                          EPerson newowner)
                   throws SQLException,
                          IOException,
                          AuthorizeException

Throws:: SQLException; IOException; AuthorizeException

assignToReviewer
```
protected void assignToReviewer(Context context,
                                BasicWorkflowItem workflowItem,
                                int step,
                                EPerson newowner)
                         throws AuthorizeException,
                                SQLException
```
Helper method to take an item out of the pool, to assign it to a reviewer and to deal with reviewer policies. Don't use this method directly. Instead: use start(Context, WorkspaceItem) to start a workflow and claim(Context, BasicWorkflowItem, EPerson) as those methods handles the internal states and checks for the appropriate permissions.

Parameters:

context - DSpace context object

workflowItem - The item that shall be pooled.

step - The step (1-3) of the pool the item should be put to.

newowner - The EPerson that should do the review.

Throws:

SQLException

AuthorizeException

IOException

IllegalArgumentException - If param has another value than either 1, 2, or 3.

pool
```
protected boolean pool(Context context,
                       BasicWorkflowItem workflowItem,
                       int step)
                throws SQLException,
                       AuthorizeException,
                       IOException
```
Helper method that manages state, policies, owner, notifies, tasklistitems and so on whenever an WorkflowItem should be added to a workflow step pool. Don't use this method directly. Either use unclaim(Context, BasicWorkflowItem, EPerson) if the item is claimed, start(Context, WorkspaceItem) to start the workflow or advance(Context, BasicWorkflowItem, EPerson) to move an item to the next state.

Parameters:

context - DSpace context object

workflowItem - The item that shall be pooled.

step - The step (1-3) of the pool the item should be put to.

Returns:

True if the item was archived because no reviewers were assigned to any of the following workflow steps, false otherwise.

Throws:

SQLException

AuthorizeException

IOException

IllegalArgumentException - If param has another value than either 1, 2, or 3.

logWorkflowEvent

protected void logWorkflowEvent(Context context,
                                Item item,
                                BasicWorkflowItem workflowItem,
                                EPerson actor,
                                int newstate,
                                EPerson newOwner,
                                Collection mycollection,
                                int oldState,
                                Group newOwnerGroup)

getWorkflowText
```
public String getWorkflowText(int state)
```
Description copied from interface: BasicWorkflowService

Get the text representing the given workflow state

Specified by:

getWorkflowText in interface BasicWorkflowService

Parameters:

state - the workflow state

Returns:

the text representation

notifyOfArchive

protected void notifyOfArchive(Context context,
                               Item item,
                               Collection coll)
                        throws SQLException,
                               IOException

notify the submitter that the item is archived

Throws:: SQLException; IOException

returnToWorkspace

protected WorkspaceItem returnToWorkspace(Context c,
                                          BasicWorkflowItem wfi)
                                   throws SQLException,
                                          IOException,
                                          AuthorizeException

Return the workflow item to the workspace of the submitter. The workflow item is removed, and a workspace item created.

Parameters:: c - Context; wfi - WorkflowItem to be 'dismantled'
Returns:: the workspace item
Throws:: SQLException; IOException; AuthorizeException

sendWorkflowItemBackSubmission

public WorkspaceItem sendWorkflowItemBackSubmission(Context context,
                                                    BasicWorkflowItem workflowItem,
                                                    EPerson ePerson,
                                                    String provenancePrefix,
                                                    String rejection_message)
                                             throws SQLException,
                                                    AuthorizeException,
                                                    IOException

Specified by:: sendWorkflowItemBackSubmission in interface WorkflowService<BasicWorkflowItem>
Throws:: SQLException; AuthorizeException; IOException

createTasks

protected void createTasks(Context c,
                           BasicWorkflowItem wi,
                           List<EPerson> epa)
                    throws SQLException

Throws:: SQLException

notifyOfCuration

public void notifyOfCuration(Context c,
                             BasicWorkflowItem wi,
                             List<EPerson> ePeople,
                             String taskName,
                             String action,
                             String message)
                      throws SQLException,
                             IOException

Specified by:: notifyOfCuration in interface BasicWorkflowService
Throws:: SQLException; IOException

notifyGroupOfTask

protected void notifyGroupOfTask(Context c,
                                 BasicWorkflowItem wi,
                                 Group mygroup,
                                 List<EPerson> epa)
                          throws SQLException,
                                 IOException

Throws:: SQLException; IOException

getMyDSpaceLink
```
public String getMyDSpaceLink()
```
Specified by:

getMyDSpaceLink in interface WorkflowService<BasicWorkflowItem>

notifyOfReject

protected void notifyOfReject(Context context,
                              BasicWorkflowItem workflowItem,
                              EPerson e,
                              String reason)

getItemTitle
```
public String getItemTitle(BasicWorkflowItem wi)
                    throws SQLException
```
Description copied from interface: BasicWorkflowService

get the title of the item in this workflow

Specified by:

getItemTitle in interface BasicWorkflowService

Parameters:

wi - the workflow item object

Throws:

SQLException

getSubmitterName
```
public String getSubmitterName(BasicWorkflowItem wi)
                        throws SQLException
```
Description copied from interface: BasicWorkflowService

get the name of the eperson who started this workflow

Specified by:

getSubmitterName in interface BasicWorkflowService

Parameters:

wi - the workflow item

Throws:

SQLException

getEPersonName

protected String getEPersonName(EPerson e)
                         throws SQLException

Throws:: SQLException

recordApproval

protected void recordApproval(Context context,
                              BasicWorkflowItem workflowItem,
                              EPerson e)
                       throws SQLException,
                              IOException,
                              AuthorizeException

Throws:: SQLException; IOException; AuthorizeException

recordStart

protected void recordStart(Context context,
                           Item myitem)
                    throws SQLException,
                           IOException,
                           AuthorizeException

Throws:: SQLException; IOException; AuthorizeException

deleteCollection

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

Specified by:: deleteCollection in interface WorkflowService<BasicWorkflowItem>
Throws:: SQLException; IOException; AuthorizeException

getEPersonDeleteConstraints

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

Specified by:: getEPersonDeleteConstraints in interface WorkflowService<BasicWorkflowItem>
Throws:: SQLException

getWorkflowRoleGroup

public Group getWorkflowRoleGroup(Context context,
                                  Collection collection,
                                  String roleName,
                                  Group roleGroup)
                           throws SQLException,
                                  AuthorizeException

Specified by:: getWorkflowRoleGroup in interface WorkflowService<BasicWorkflowItem>
Throws:: SQLException; AuthorizeException

getFlywayMigrationLocations
```
public List<String> getFlywayMigrationLocations()
```
Specified by:

getFlywayMigrationLocations in interface WorkflowService<BasicWorkflowItem>

Class BasicWorkflowServiceImpl

Field Summary

Fields inherited from interface org.dspace.workflowbasic.service.BasicWorkflowService

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

authorizeService

collectionService

groupService

handleService

installItemService

itemService

taskListItemService

workflowCuratorService

workflowItemService

workspaceItemService

configurationService

workflowText

noEMail

Constructor Detail

BasicWorkflowServiceImpl

Method Detail

getWorkflowID

grantReviewerPolicies

revokeReviewerPolicies

start

startWithoutNotify

getOwnedTasks

getPooledTasks

claim

advance

advance

unclaim

abort

doState

assignToReviewer

pool