org.dspace.content

Class WorkspaceItemServiceImpl

java.lang.Object

org.dspace.content.WorkspaceItemServiceImpl

All Implemented Interfaces:

IndexableObjectService<WorkspaceItem,Integer>, InProgressSubmissionService<WorkspaceItem,Integer>, WorkspaceItemService

public class WorkspaceItemServiceImpl
extends Object
implements WorkspaceItemService

Service implementation for the WorkspaceItem object. This class is responsible for all business logic calls for the WorkspaceItem 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 AuthorizeService	authorizeService
protected CollectionService	collectionService
protected ItemService	itemService
protected WorkflowService	workflowService
protected WorkspaceItemDAO	workspaceItemDAO

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	WorkspaceItemServiceImpl()

Method Summary

Modifier and Type	Method and Description
int	countByEPerson(Context context, EPerson ep)
int	countTotal(Context context)
WorkspaceItem	create(Context context, Collection collection, boolean template) Create a new workspace item, with a new ID.
WorkspaceItem	create(Context c, WorkflowItem workflowItem)
void	deleteAll(Context context, WorkspaceItem workspaceItem) Delete the workspace item.
void	deleteWrapper(Context context, WorkspaceItem workspaceItem) Deletes submission wrapper, doesn't delete item contents
WorkspaceItem	find(Context context, int id) Get a workspace item from the database.
List<WorkspaceItem>	findAll(Context context) Get all workspace items in the whole system
List<WorkspaceItem>	findAll(Context context, Integer limit, Integer offset) Get all workspace items in the whole system, paginated.
List<WorkspaceItem>	findAllSupervisedItems(Context context)
List<WorkspaceItem>	findByCollection(Context context, Collection collection) Get all workspace items for a particular collection.
List<WorkspaceItem>	findByEPerson(Context context, EPerson ep) Get all workspace items for a particular e-person.
List<WorkspaceItem>	findByEPerson(Context context, EPerson ep, Integer limit, Integer offset) Get a page of workspace items for a particular e-person.
WorkspaceItem	findByItem(Context context, Item item) Check to see if a particular item is currently still in a user's Workspace.
WorkspaceItem	findIndexableObject(Context context, Integer id) Generic find for when the precise type of an IndexableObject is not known
List<WorkspaceItem>	findSupervisedItemsByEPerson(Context context, EPerson ePerson)
List<Map.Entry<Integer,Long>>	getStageReachedCounts(Context context) The map entry returned contains stage reached as the key and count of items in that stage as a value
int	getSupportsIndexableObjectTypeConstant() Returns the Constants which this service supports
void	move(Context context, WorkspaceItem source, Collection fromCollection, Collection toCollection)
void	update(Context context, WorkspaceItem workspaceItem) 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

workspaceItemDAO

@Autowired(required=true)
protected WorkspaceItemDAO workspaceItemDAO

authorizeService

@Autowired(required=true)
protected AuthorizeService authorizeService

collectionService

@Autowired(required=true)
protected CollectionService collectionService

itemService

@Autowired(required=true)
protected ItemService itemService

workflowService

@Autowired(required=true)
protected WorkflowService workflowService

Constructor Detail

WorkspaceItemServiceImpl

protected WorkspaceItemServiceImpl()

Method Detail

getSupportsIndexableObjectTypeConstant

public int getSupportsIndexableObjectTypeConstant()

Description copied from interface: IndexableObjectService

Returns the Constants which this service supports

Specified by:

getSupportsIndexableObjectTypeConstant in interface IndexableObjectService<WorkspaceItem,Integer>

Returns:

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

find

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

Description copied from interface: WorkspaceItemService

Get a workspace item from the database. The item, collection and submitter are loaded into memory.

Specified by:

find in interface WorkspaceItemService

Parameters:

context - DSpace context object

id - ID of the workspace item

Returns:

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

Throws:

SQLException - if database error

findIndexableObject

public WorkspaceItem 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<WorkspaceItem,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.

create

public WorkspaceItem create(Context context,
                            Collection collection,
                            boolean template)
                     throws AuthorizeException,
                            SQLException

Description copied from interface: WorkspaceItemService

Create a new workspace item, with a new ID. An Item is also created. The submitter is the current user in the context.

Specified by:

create in interface WorkspaceItemService

Parameters:

context - DSpace context object

collection - Collection being submitted to

template - if true, the workspace item starts as a copy of the collection's template item

Returns:

the newly created workspace item

Throws:

AuthorizeException - if authorization error

SQLException - if database error

create

public WorkspaceItem create(Context c,
                            WorkflowItem workflowItem)
                     throws SQLException,
                            AuthorizeException

Specified by:

create in interface WorkspaceItemService

Throws:

SQLException

AuthorizeException

findByEPerson

public List<WorkspaceItem> findByEPerson(Context context,
                                         EPerson ep)
                                  throws SQLException

Description copied from interface: WorkspaceItemService

Get all workspace items for a particular e-person. These are ordered by workspace item ID, since this should likely keep them in the order in which they were created.

Specified by:

findByEPerson in interface WorkspaceItemService

Parameters:

context - the context object

ep - the eperson

Returns:

the corresponding workspace items

Throws:

SQLException - if database error

findByEPerson

public List<WorkspaceItem> findByEPerson(Context context,
                                         EPerson ep,
                                         Integer limit,
                                         Integer offset)
                                  throws SQLException

Description copied from interface: WorkspaceItemService

Get a page of workspace items for a particular e-person. These are ordered by workspace item ID, since this should likely keep them in the order in which they were created.

Specified by:

findByEPerson in interface WorkspaceItemService

Parameters:

context - the context object

ep - the eperson

limit - the max number of workspaceitems to return

offset - the offset

Returns:

the corresponding workspace items

Throws:

SQLException - if database error

findByCollection

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

Description copied from interface: WorkspaceItemService

Get all workspace items for a particular collection.

Specified by:

findByCollection in interface WorkspaceItemService

Parameters:

context - the context object

collection - the collection

Returns:

the corresponding workspace items

Throws:

SQLException - if database error

findByItem

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

Description copied from interface: WorkspaceItemService

Check to see if a particular item is currently still in a user's Workspace. If so, its WorkspaceItem is returned. If not, null is returned

Specified by:

findByItem in interface WorkspaceItemService

Parameters:

context - the context object

item - the item

Returns:

workflow item corresponding to the item, or null

Throws:

SQLException - if database error

findAllSupervisedItems

public List<WorkspaceItem> findAllSupervisedItems(Context context)
                                           throws SQLException

Specified by:

findAllSupervisedItems in interface WorkspaceItemService

Throws:

SQLException

findSupervisedItemsByEPerson

public List<WorkspaceItem> findSupervisedItemsByEPerson(Context context,
                                                        EPerson ePerson)
                                                 throws SQLException

Specified by:

findSupervisedItemsByEPerson in interface WorkspaceItemService

Throws:

SQLException

findAll

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

Description copied from interface: WorkspaceItemService

Get all workspace items in the whole system

Specified by:

findAll in interface WorkspaceItemService

Parameters:

context - the context object

Returns:

all workspace items

Throws:

SQLException - if database error

findAll

public List<WorkspaceItem> findAll(Context context,
                                   Integer limit,
                                   Integer offset)
                            throws SQLException

Description copied from interface: WorkspaceItemService

Get all workspace items in the whole system, paginated.

Specified by:

findAll in interface WorkspaceItemService

Parameters:

context - the context object

limit - limit

offset - offset

Returns:

a page of workspace items

Throws:

SQLException - if database error

update

public void update(Context context,
                   WorkspaceItem workspaceItem)
            throws SQLException,
                   AuthorizeException

Description copied from interface: InProgressSubmissionService

Update the submission, including the unarchived item.

Specified by:

update in interface InProgressSubmissionService<WorkspaceItem,Integer>

Parameters:

context - context

workspaceItem - submission

Throws:

SQLException - if database error

AuthorizeException - if authorization error

deleteAll

public void deleteAll(Context context,
                      WorkspaceItem workspaceItem)
               throws SQLException,
                      AuthorizeException,
                      IOException

Description copied from interface: WorkspaceItemService

Delete the workspace item. The entry in workspaceitem, the unarchived item and its contents are all removed (multiple inclusion notwithstanding.)

Specified by:

deleteAll in interface WorkspaceItemService

Parameters:

context - context

workspaceItem - workspace item

Throws:

SQLException - if database error

AuthorizeException - if authorization error

IOException - if IO error

countTotal

public int countTotal(Context context)
               throws SQLException

Specified by:

countTotal in interface WorkspaceItemService

Throws:

SQLException

countByEPerson

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

Specified by:

countByEPerson in interface WorkspaceItemService

Throws:

SQLException

getStageReachedCounts

public List<Map.Entry<Integer,Long>> getStageReachedCounts(Context context)
                                                    throws SQLException

Description copied from interface: WorkspaceItemService

The map entry returned contains stage reached as the key and count of items in that stage as a value

Specified by:

getStageReachedCounts in interface WorkspaceItemService

Parameters:

context - The relevant DSpace Context.

Returns:

the map

Throws:

SQLException - if database error

deleteWrapper

public void deleteWrapper(Context context,
                          WorkspaceItem workspaceItem)
                   throws SQLException,
                          AuthorizeException

Description copied from interface: InProgressSubmissionService

Deletes submission wrapper, doesn't delete item contents

Specified by:

deleteWrapper in interface InProgressSubmissionService<WorkspaceItem,Integer>

Parameters:

context - context

workspaceItem - submission

Throws:

SQLException - if database error

AuthorizeException - if authorization error

move

public void move(Context context,
                 WorkspaceItem source,
                 Collection fromCollection,
                 Collection toCollection)
          throws DCInputsReaderException

Specified by:

move in interface InProgressSubmissionService<WorkspaceItem,Integer>

Throws:

DCInputsReaderException