org.dspace.xmlworkflow.storedcomponents

Class XmlWorkflowItemServiceImpl

java.lang.Object

org.dspace.xmlworkflow.storedcomponents.XmlWorkflowItemServiceImpl

All Implemented Interfaces:

InProgressSubmissionService<XmlWorkflowItem>, 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 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
XmlWorkflowItem	create(Context context, Item item, Collection collection)
void	delete(Context context, XmlWorkflowItem workflowItem)
void	deleteByCollection(Context context, Collection 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 offset, Integer pagesize) return all workflowitems for a certain page
List<XmlWorkflowItem>	findAllInCollection(Context context, Integer offset, 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.
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

workflowItemRoleService

@Autowired(required=true)
protected WorkflowItemRoleService workflowItemRoleService

Constructor Detail

XmlWorkflowItemServiceImpl

protected XmlWorkflowItemServiceImpl()

Method Detail

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 - DSpace context object

id - ID of the workflow item

Returns:

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

Throws:

SQLException

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 - active context

Returns:

List of all workflowItems in system

Throws:

SQLException

findAll

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

Description copied from interface: XmlWorkflowItemService

return all workflowitems for a certain page

Specified by:

findAll in interface XmlWorkflowItemService

Parameters:

context - active context

Returns:

WorkflowItem list of all the workflow items in system

Throws:

SQLException

findAllInCollection

public List<XmlWorkflowItem> findAllInCollection(Context context,
                                                 Integer offset,
                                                 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

collection - active context

Returns:

WorkflowItem list of all the workflow items in system

Throws:

SQLException

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 - active context

Returns:

the number of workflow items

Throws:

SQLException

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 - active context

Returns:

the number of workflow items

Throws:

SQLException

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 context object

ep - the eperson

Returns:

the corresponding workflow items

Throws:

SQLException

deleteByCollection

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

Specified by:

deleteByCollection in interface WorkflowItemService<XmlWorkflowItem>

Throws:

SQLException

IOException

AuthorizeException

delete

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

Specified by:

delete in interface WorkflowItemService<XmlWorkflowItem>

Throws:

SQLException

AuthorizeException

IOException

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 context object

collection - the collection

Returns:

array of the corresponding workflow items

Throws:

SQLException

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 context object

item - the item

Returns:

workflow item corresponding to the item, or null

Throws:

SQLException

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>

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>

Parameters:

context - context

workflowItem - submission

Throws:

SQLException - if database error

AuthorizeException - if authorization error