org.dspace.workflow

Interface WorkflowItemService<T extends WorkflowItem>

All Superinterfaces:

InProgressSubmissionService<T>

All Known Subinterfaces:

BasicWorkflowItemService, XmlWorkflowItemService

All Known Implementing Classes:

BasicWorkflowItemServiceImpl, XmlWorkflowItemServiceImpl

public interface WorkflowItemService<T extends WorkflowItem>
extends InProgressSubmissionService<T>

Service interface class for the Workflow items. All WorkflowItem service classes should implement this class since it offers some basic methods which all WorkflowItems are required to have.

Author:

kevinvandevelde at atmire.com

Method Summary

Methods

Modifier and Type	Method and Description
T	create(Context context, Item item, Collection collection)
void	delete(Context context, T workflowItem)
void	deleteByCollection(Context context, Collection collection)
T	find(Context context, int id) Get a workflow item from the database.
List<T>	findAll(Context context) return all workflowitems
List<T>	findByCollection(Context context, Collection collection) Get all workflow items for a particular collection.
T	findByItem(Context context, Item item) Check to see if a particular item is currently under Workflow.
List<T>	findBySubmitter(Context context, EPerson ep) Get all workflow items that were original submissions by a particular e-person.

Methods inherited from interface org.dspace.content.service.InProgressSubmissionService

deleteWrapper, update

Method Detail

create

T create(Context context,
       Item item,
       Collection collection)
                              throws SQLException,
                                     AuthorizeException

Throws:

SQLException

AuthorizeException

find

T find(Context context,
     int id)
                            throws SQLException

Get a workflow item from the database.

Parameters:

context - DSpace context object

id - ID of the workflow item

Returns:

the workflow item, or null if the ID is invalid.

Throws:

SQLException

findAll

List<T> findAll(Context context)
                                     throws SQLException

return all workflowitems

Parameters:

context - active context

Returns:

List of all workflowItems in system

Throws:

SQLException

findByCollection

List<T> findByCollection(Context context,
                       Collection collection)
                                              throws SQLException

Get all workflow items for a particular collection.

Parameters:

context - the context object

collection - the collection

Returns:

array of the corresponding workflow items

Throws:

SQLException

findByItem

T findByItem(Context context,
           Item item)
                                  throws SQLException

Check to see if a particular item is currently under Workflow. If so, its WorkflowItem is returned. If not, null is returned

Parameters:

context - the context object

item - the item

Returns:

workflow item corresponding to the item, or null

Throws:

SQLException

findBySubmitter

List<T> findBySubmitter(Context context,
                      EPerson ep)
                                             throws SQLException

Get all workflow items that were original submissions by a particular e-person.

Parameters:

context - the context object

ep - the eperson

Returns:

the corresponding workflow items

Throws:

SQLException

deleteByCollection

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

Throws:

SQLException

IOException

AuthorizeException

delete

void delete(Context context,
          T workflowItem)
            throws SQLException,
                   AuthorizeException,
                   IOException

Throws:

SQLException

AuthorizeException

IOException