Package org.dspace.workflowbasic

Class BasicWorkflowItemServiceImpl

java.lang.Object

org.dspace.workflowbasic.BasicWorkflowItemServiceImpl

All Implemented Interfaces:

InProgressSubmissionService<BasicWorkflowItem>, WorkflowItemService<BasicWorkflowItem>, BasicWorkflowItemService

public class BasicWorkflowItemServiceImpl
extends Object
implements BasicWorkflowItemService

Service implementation for the BasicWorkflowItem object. This class is responsible for all business logic calls for the BasicWorkflowItem object and is autowired by spring. This class should never be accessed directly.

Author:

kevinvandevelde at atmire.com

Field Summary

Fields

Modifier and Type	Field	Description
protected ItemService	itemService
protected static org.apache.logging.log4j.Logger	log	log4j category
protected TaskListItemService	taskListItemService
protected BasicWorkflowItemDAO	workflowItemDAO

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	BasicWorkflowItemServiceImpl()

Method Summary

Modifier and Type	Method	Description
int	countTotal(Context context)
BasicWorkflowItem	create(Context context, Item item, Collection collection)
void	delete(Context context, BasicWorkflowItem workflowItem)	Delete the specified workflow item.
void	deleteByCollection(Context context, Collection collection)	Delete all workflow items present in the specified collection.
void	deleteWrapper(Context context, BasicWorkflowItem workflowItem)	Deletes submission wrapper, doesn't delete item contents
BasicWorkflowItem	find(Context context, int id)	Get a workflow item from the database.
List<BasicWorkflowItem>	findAll(Context context)	return all workflowitems
List<BasicWorkflowItem>	findByCollection(Context context, Collection collection)	Get all workflow items for a particular collection.
BasicWorkflowItem	findByItem(Context context, Item item)	Check to see if a particular item is currently under Workflow.
List<BasicWorkflowItem>	findByOwner(Context context, EPerson ePerson)	Retrieve the list of BasicWorkflowItems that the given EPerson is owner of (owner == claimed for review)
List<BasicWorkflowItem>	findBySubmitter(Context context, EPerson ep)	Get all workflow items that were original submissions by a particular e-person.
List<BasicWorkflowItem>	findPooledTasks(Context context, EPerson ePerson)
void	move(Context context, BasicWorkflowItem inProgressSubmission, Collection fromCollection, Collection toCollection)
void	update(Context context, BasicWorkflowItem workflowItem)	Update the submission, including the unarchived item.

Methods inherited from class java.lang.Object

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

Field Detail

log

protected static org.apache.logging.log4j.Logger log

log4j category

workflowItemDAO

@Autowired(required=true)
protected BasicWorkflowItemDAO workflowItemDAO

itemService

@Autowired(required=true)
protected ItemService itemService

taskListItemService

@Autowired(required=true)
protected TaskListItemService taskListItemService

Constructor Detail

BasicWorkflowItemServiceImpl

protected BasicWorkflowItemServiceImpl()

Method Detail

create

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

Specified by:

create in interface WorkflowItemService<BasicWorkflowItem>

Throws:

SQLException

AuthorizeException

find

public BasicWorkflowItem find(Context context,
                              int id)
                       throws SQLException

Description copied from interface: WorkflowItemService

Get a workflow item from the database.

Specified by:

find in interface WorkflowItemService<BasicWorkflowItem>

Parameters:

context - The relevant DSpace Context.

id - ID of the workflow item

Returns:

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

Throws:

SQLException - An exception that provides information on a database access error or other errors.

findAll

public List<BasicWorkflowItem> findAll(Context context)
                                throws SQLException

Description copied from interface: WorkflowItemService

return all workflowitems

Specified by:

findAll in interface WorkflowItemService<BasicWorkflowItem>

Parameters:

context - The relevant DSpace Context.

Returns:

List of all workflowItems in system

Throws:

SQLException - An exception that provides information on a database access error or other errors.

findBySubmitter

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

Description copied from interface: WorkflowItemService

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

Specified by:

findBySubmitter in interface WorkflowItemService<BasicWorkflowItem>

Parameters:

context - The relevant DSpace Context.

ep - the eperson

Returns:

the corresponding workflow items

Throws:

SQLException - An exception that provides information on a database access error or other errors.

deleteByCollection

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

Description copied from interface: WorkflowItemService

Delete all workflow items present in the specified collection.

Specified by:

deleteByCollection in interface WorkflowItemService<BasicWorkflowItem>

Parameters:

context - The relevant DSpace Context.

collection - the containing collection

Throws:

SQLException - An exception that provides information on a database access error or other errors.

IOException - A general class of exceptions produced by failed or interrupted I/O operations.

AuthorizeException - Exception indicating the current user of the context does not have permission to perform a particular action.

delete

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

Description copied from interface: WorkflowItemService

Delete the specified workflow item.

Specified by:

delete in interface WorkflowItemService<BasicWorkflowItem>

Parameters:

context - The relevant DSpace Context.

workflowItem - which workflow item to delete

Throws:

SQLException - An exception that provides information on a database access error or other errors.

AuthorizeException - Exception indicating the current user of the context does not have permission to perform a particular action.

IOException - A general class of exceptions produced by failed or interrupted I/O operations.

findByCollection

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

Description copied from interface: WorkflowItemService

Get all workflow items for a particular collection.

Specified by:

findByCollection in interface WorkflowItemService<BasicWorkflowItem>

Parameters:

context - The relevant DSpace Context.

collection - the collection

Returns:

array of the corresponding workflow items

Throws:

SQLException - An exception that provides information on a database access error or other errors.

findByItem

public BasicWorkflowItem findByItem(Context context,
                                    Item item)
                             throws SQLException

Description copied from interface: WorkflowItemService

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

Specified by:

findByItem in interface WorkflowItemService<BasicWorkflowItem>

Parameters:

context - The relevant DSpace Context.

item - the item

Returns:

workflow item corresponding to the item, or null

Throws:

SQLException - An exception that provides information on a database access error or other errors.

deleteWrapper

public void deleteWrapper(Context context,
                          BasicWorkflowItem workflowItem)
                   throws SQLException,
                          AuthorizeException

Description copied from interface: InProgressSubmissionService

Deletes submission wrapper, doesn't delete item contents

Specified by:

deleteWrapper in interface InProgressSubmissionService<BasicWorkflowItem>

Parameters:

context - context

workflowItem - submission

Throws:

SQLException - if database error

AuthorizeException - if authorization error

update

public void update(Context context,
                   BasicWorkflowItem workflowItem)
            throws SQLException,
                   AuthorizeException

Description copied from interface: InProgressSubmissionService

Update the submission, including the unarchived item.

Specified by:

update in interface InProgressSubmissionService<BasicWorkflowItem>

Parameters:

context - context

workflowItem - submission

Throws:

SQLException - if database error

AuthorizeException - if authorization error

findPooledTasks

public List<BasicWorkflowItem> findPooledTasks(Context context,
                                               EPerson ePerson)
                                        throws SQLException

Specified by:

findPooledTasks in interface BasicWorkflowItemService

Throws:

SQLException

findByOwner

public List<BasicWorkflowItem> findByOwner(Context context,
                                           EPerson ePerson)
                                    throws SQLException

Description copied from interface: BasicWorkflowItemService

Retrieve the list of BasicWorkflowItems that the given EPerson is owner of (owner == claimed for review)

Specified by:

findByOwner in interface BasicWorkflowItemService

Parameters:

context - The relevant DSpace Context.

ePerson - The DSpace EPerson object.

Returns:

a list of BasicWorkflowItem objects

Throws:

SQLException - An exception that provides information on a database access error or other errors.

countTotal

public int countTotal(Context context)
               throws SQLException

Specified by:

countTotal in interface BasicWorkflowItemService

Throws:

SQLException

move

public void move(Context context,
                 BasicWorkflowItem inProgressSubmission,
                 Collection fromCollection,
                 Collection toCollection)

Specified by:

move in interface InProgressSubmissionService<BasicWorkflowItem>