org.dspace.xmlworkflow.storedcomponents

Class XmlWorkflowItemServiceImpl

java.lang.Object

org.dspace.xmlworkflow.storedcomponents.XmlWorkflowItemServiceImpl

All Implemented Interfaces:

IndexableObjectService<XmlWorkflowItem,Integer>, InProgressSubmissionService<XmlWorkflowItem,Integer>, WorkflowItemService<XmlWorkflowItem>, XmlWorkflowItemService

public class XmlWorkflowItemServiceImpl
extends Object
implements XmlWorkflowItemService

Service implementation for the XmlWorkflowItem object. This class is responsible for all business logic calls for the XmlWorkflowItem 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 and Description
protected ClaimedTaskService	claimedTaskService
protected ItemService	itemService
protected PoolTaskService	poolTaskService
protected WorkflowItemRoleService	workflowItemRoleService
protected WorkflowRequirementsService	workflowRequirementsService
protected XmlWorkflowItemDAO	xmlWorkflowItemDAO

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	XmlWorkflowItemServiceImpl()

Method Summary

Modifier and Type	Method and Description
int	countAll(Context context) return how many workflow items appear in the database
int	countAllInCollection(Context context, Collection collection) return how many workflow items that appear in the collection
int	countBySubmitter(Context context, EPerson ep) Count the number of workflow items from a specific submitter
XmlWorkflowItem	create(Context context, Item item, Collection collection)
void	delete(Context context, XmlWorkflowItem 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, XmlWorkflowItem workflowItem) Deletes submission wrapper, doesn't delete item contents
XmlWorkflowItem	find(Context context, int id) Get a workflow item from the database.
List<XmlWorkflowItem>	findAll(Context context) return all workflowitems
List<XmlWorkflowItem>	findAll(Context context, Integer page, Integer pagesize) return all workflowitems for a certain page
List<XmlWorkflowItem>	findAllInCollection(Context context, Integer page, Integer pagesize, Collection collection) return all workflowitems for a certain page with a certain collection
List<XmlWorkflowItem>	findByCollection(Context context, Collection collection) Get all workflow items for a particular collection.
XmlWorkflowItem	findByItem(Context context, Item item) Check to see if a particular item is currently under Workflow.
List<XmlWorkflowItem>	findBySubmitter(Context context, EPerson ep) Get all workflow items that were original submissions by a particular e-person.
List<XmlWorkflowItem>	findBySubmitter(Context context, EPerson ep, Integer pageNumber, Integer pageSize) Return all the workflow items from a specific submitter respecting the pagination parameters
XmlWorkflowItem	findIndexableObject(Context context, Integer id) Generic find for when the precise type of an IndexableObject is not known
int	getSupportsIndexableObjectTypeConstant() Returns the Constants which this service supports
void	move(Context context, XmlWorkflowItem inProgressSubmission, Collection fromCollection, Collection toCollection)
void	update(Context context, XmlWorkflowItem 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

xmlWorkflowItemDAO

@Autowired(required=true)
protected XmlWorkflowItemDAO xmlWorkflowItemDAO

claimedTaskService

@Autowired(required=true)
protected ClaimedTaskService claimedTaskService

itemService

@Autowired(required=true)
protected ItemService itemService

poolTaskService

@Autowired(required=true)
protected PoolTaskService poolTaskService

workflowRequirementsService

@Autowired(required=true)
protected WorkflowRequirementsService workflowRequirementsService

workflowItemRoleService

@Autowired(required=true)
protected WorkflowItemRoleService workflowItemRoleService

Constructor Detail

XmlWorkflowItemServiceImpl

protected XmlWorkflowItemServiceImpl()

Method Detail

getSupportsIndexableObjectTypeConstant

public int getSupportsIndexableObjectTypeConstant()

Description copied from interface: IndexableObjectService

Returns the Constants which this service supports

Specified by:

getSupportsIndexableObjectTypeConstant in interface IndexableObjectService<XmlWorkflowItem,Integer>

Returns:

a org.dspace.core.Constants that represents a IndexableObject type

create

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

Specified by:

create in interface WorkflowItemService<XmlWorkflowItem>

Throws:

SQLException

AuthorizeException

find

public XmlWorkflowItem 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<XmlWorkflowItem>

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.

findIndexableObject

public XmlWorkflowItem findIndexableObject(Context context,
                                           Integer id)
                                    throws SQLException

Description copied from interface: IndexableObjectService

Generic find for when the precise type of an IndexableObject is not known

Specified by:

findIndexableObject in interface IndexableObjectService<XmlWorkflowItem,Integer>

Parameters:

context - - the context

id - - id within table of type'd indexable objects

Returns:

the indexable object found, or null if it does not exist.

Throws:

SQLException - only upon failure accessing the database.

findAll

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

Description copied from interface: WorkflowItemService

return all workflowitems

Specified by:

findAll in interface WorkflowItemService<XmlWorkflowItem>

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.

findAll

public List<XmlWorkflowItem> findAll(Context context,
                                     Integer page,
                                     Integer pagesize)
                              throws SQLException

Description copied from interface: XmlWorkflowItemService

return all workflowitems for a certain page

Specified by:

findAll in interface XmlWorkflowItemService

Parameters:

context - The relevant DSpace Context.

page - paging: page number

pagesize - paging: items per page

Returns:

WorkflowItem list of all the workflow items in system

Throws:

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

findAllInCollection

public List<XmlWorkflowItem> findAllInCollection(Context context,
                                                 Integer page,
                                                 Integer pagesize,
                                                 Collection collection)
                                          throws SQLException

Description copied from interface: XmlWorkflowItemService

return all workflowitems for a certain page with a certain collection

Specified by:

findAllInCollection in interface XmlWorkflowItemService

Parameters:

context - The relevant DSpace Context.

page - paging: page number

pagesize - paging: items per page

collection - restrict to this collection

Returns:

WorkflowItem list of all the workflow items in system

Throws:

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

countAll

public int countAll(Context context)
             throws SQLException

Description copied from interface: XmlWorkflowItemService

return how many workflow items appear in the database

Specified by:

countAll in interface XmlWorkflowItemService

Parameters:

context - The relevant DSpace Context.

Returns:

the number of workflow items

Throws:

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

countAllInCollection

public int countAllInCollection(Context context,
                                Collection collection)
                         throws SQLException

Description copied from interface: XmlWorkflowItemService

return how many workflow items that appear in the collection

Specified by:

countAllInCollection in interface XmlWorkflowItemService

Parameters:

context - The relevant DSpace Context.

collection - restrict to this collection

Returns:

the number of workflow items

Throws:

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

findBySubmitter

public List<XmlWorkflowItem> 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<XmlWorkflowItem>

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.

findBySubmitter

public List<XmlWorkflowItem> findBySubmitter(Context context,
                                             EPerson ep,
                                             Integer pageNumber,
                                             Integer pageSize)
                                      throws SQLException

Description copied from interface: XmlWorkflowItemService

Return all the workflow items from a specific submitter respecting the pagination parameters

Specified by:

findBySubmitter in interface XmlWorkflowItemService

Parameters:

context - The relevant DSpace Context.

ep - the eperson that has submitted the item

pageNumber - paging: page number

pageSize - paging: items per page

Returns:

Throws:

SQLException

countBySubmitter

public int countBySubmitter(Context context,
                            EPerson ep)
                     throws SQLException

Description copied from interface: XmlWorkflowItemService

Count the number of workflow items from a specific submitter

Specified by:

countBySubmitter in interface XmlWorkflowItemService

Parameters:

context - The relevant DSpace Context.

ep - the eperson that has submitted the item

Returns:

Throws:

SQLException

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<XmlWorkflowItem>

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,
                   XmlWorkflowItem workflowItem)
            throws SQLException,
                   AuthorizeException,
                   IOException

Description copied from interface: WorkflowItemService

Delete the specified workflow item.

Specified by:

delete in interface WorkflowItemService<XmlWorkflowItem>

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<XmlWorkflowItem> 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<XmlWorkflowItem>

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 XmlWorkflowItem 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<XmlWorkflowItem>

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.

update

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

Description copied from interface: InProgressSubmissionService

Update the submission, including the unarchived item.

Specified by:

update in interface InProgressSubmissionService<XmlWorkflowItem,Integer>

Parameters:

context - context

workflowItem - submission

Throws:

SQLException - if database error

AuthorizeException - if authorization error

deleteWrapper

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

Description copied from interface: InProgressSubmissionService

Deletes submission wrapper, doesn't delete item contents

Specified by:

deleteWrapper in interface InProgressSubmissionService<XmlWorkflowItem,Integer>

Parameters:

context - context

workflowItem - submission

Throws:

SQLException - if database error

AuthorizeException - if authorization error

move

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

Specified by:

move in interface InProgressSubmissionService<XmlWorkflowItem,Integer>