org.dspace.content.service

Interface ItemService

All Superinterfaces:

DSpaceObjectLegacySupportService<Item>, DSpaceObjectService<Item>

All Known Implementing Classes:

ItemServiceImpl

public interface ItemService
extends DSpaceObjectService<Item>, DSpaceObjectLegacySupportService<Item>

Service interface class for the Item object. The implementation of this class is responsible for all business logic calls for the Item object and is autowired by spring

Author:

kevinvandevelde at atmire.com

Method Summary

Methods

Modifier and Type	Method and Description
void	addBundle(Context context, Item item, Bundle bundle) Add an existing bundle to this item.
void	adjustBundleBitstreamPolicies(Context context, Item item, Collection collection)
void	adjustItemPolicies(Context context, Item item, Collection collection)
boolean	canEdit(Context context, Item item) return TRUE if context's user can edit item, false otherwise
int	countItems(Context context, Collection collection) counts items in the given collection
int	countItems(Context context, Community community) counts items in the given community
int	countNotArchivedItems(Context context)
int	countTotal(Context context)
int	countWithdrawnItems(Context context)
Item	create(Context context, WorkspaceItem workspaceItem) Create a new item, with a new internal ID.
Bitstream	createSingleBitstream(Context context, InputStream is, Item item) Convenience method, calls createSingleBitstream() with name "ORIGINAL"
Bitstream	createSingleBitstream(Context context, InputStream is, Item item, String name) Create a single bitstream in a new bundle.
Item	createTemplateItem(Context context, Collection collection) Create an empty template item for this collection.
Iterator<Item>	findAll(Context context) Get all the items in the archive.
Iterator<Item>	findAllByCollection(Context context, Collection collection) Get all the items in this collection.
Iterator<Item>	findAllUnfiltered(Context context) Get all "final" items in the archive, both archived ("in archive" flag) or withdrawn items are included.
Iterator<Item>	findByAuthorityValue(Context context, String schema, String element, String qualifier, String value) Find all the items in the archive with a given authority key value in the indicated metadata field.
Iterator<Item>	findByCollection(Context context, Collection collection) Get all the items in this collection.
Iterator<Item>	findByCollection(Context context, Collection collection, Integer limit, Integer offset) Get all the items in this collection.
Iterator<Item>	findByLastModifiedSince(Context context, Date last) Find all Items modified since a Date.
Iterator<Item>	findByMetadataField(Context context, String schema, String element, String qualifier, String value) Returns an iterator of Items possessing the passed metadata field, or only those matching the passed value, if value is not Item.ANY
Iterator<Item>	findByMetadataFieldAuthority(Context context, String mdString, String authority)
Iterator<Item>	findByMetadataQuery(Context context, List<List<MetadataField>> listFieldList, List<String> query_op, List<String> query_val, List<UUID> collectionUuids, String regexClause, int offset, int limit)
Iterator<Item>	findBySubmitter(Context context, EPerson eperson) Find all the items in the archive by a given submitter.
Iterator<Item>	findBySubmitterDateSorted(Context context, EPerson eperson, Integer limit) Retrieve the list of Items submitted by eperson, ordered by recently submitted, optionally limitable
Iterator<Item>	findInArchiveOrWithdrawnDiscoverableModifiedSince(Context context, Date since) Get all Items installed or withdrawn, discoverable, and modified since a Date.
List<Bundle>	getBundles(Item item, String name) Get the bundles matching a bundle name (name corresponds roughly to type)
List<Collection>	getCollectionsNotLinked(Context context, Item item) Get the collections this item is not in.
List<Community>	getCommunities(Context context, Item item) Get the communities this item is in.
List<Bitstream>	getNonInternalBitstreams(Context context, Item item) Get all non-internal bitstreams in the item.
Thumbnail	getThumbnail(Context context, Item item, boolean requireOriginal)
boolean	hasUploadedFiles(Item item) Check the bundle ORIGINAL to see if there are any uploaded files
void	inheritCollectionDefaultPolicies(Context context, Item item, Collection collection) remove all policies on an item and its contents, and replace them with the DEFAULT_ITEM_READ and DEFAULT_BITSTREAM_READ policies belonging to the collection.
boolean	isIn(Item item, Collection collection) See whether this Item is contained by a given Collection.
boolean	isItemListedForUser(Context context, Item item) Service method for knowing if this Item should be visible in the item list.
boolean	isOwningCollection(Item item, Collection collection) Return true if this Collection 'owns' this item
void	move(Context context, Item item, Collection from, Collection to) Moves the item from one collection to another one
void	move(Context context, Item item, Collection from, Collection to, boolean inheritDefaultPolicies) Moves the item from one collection to another one
void	reinstate(Context context, Item item) Reinstate a withdrawn item
void	removeAllBundles(Context context, Item item) Remove all bundles linked to this item.
void	removeBundle(Context context, Item item, Bundle bundle) Remove a bundle.
void	removeDSpaceLicense(Context context, Item item) Remove just the DSpace license from an item This is useful to update the current DSpace license, in case the user must accept the DSpace license again (either the item was rejected, or resumed after saving)
void	removeGroupPolicies(Context context, Item item, Group group) remove all of the policies for item's bitstreams and bundles that belong to a given Group
void	removeLicenses(Context context, Item item) Remove all licenses from an item - it was rejected
void	replaceAllBitstreamPolicies(Context context, Item item, List<ResourcePolicy> newpolicies) remove all of the policies for item's bitstreams and bundles and replace them with a new list of policies
void	replaceAllItemPolicies(Context context, Item item, List<ResourcePolicy> newpolicies) remove all of the policies for item and replace them with a new list of policies
void	withdraw(Context context, Item item) Withdraw the item from the archive.

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

addMetadata, addMetadata, addMetadata, addMetadata, addMetadata, addMetadata, addMetadata, clearMetadata, delete, find, getAdminObject, getIdentifiers, getMetadata, getMetadata, getMetadata, getMetadata, getMetadataByMetadataString, getMetadataFirstValue, getName, getParentObject, getSupportsTypeConstant, getTypeText, removeMetadataValues, setMetadataSingleValue, update, updateLastModified

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

findByIdOrLegacyId, findByLegacyId, getSupportsTypeConstant

Method Detail

getThumbnail

Thumbnail getThumbnail(Context context,
                     Item item,
                     boolean requireOriginal)
                       throws SQLException

Throws:

SQLException

create

Item create(Context context,
          WorkspaceItem workspaceItem)
            throws SQLException,
                   AuthorizeException

Create a new item, with a new internal ID. This method is not public, since items need to be created as workspace items. Authorisation is the responsibility of the caller.

Parameters:

context - DSpace context object

Returns:

the newly created item

Throws:

SQLException

AuthorizeException

createTemplateItem

Item createTemplateItem(Context context,
                      Collection collection)
                        throws SQLException,
                               AuthorizeException

Create an empty template item for this collection. If one already exists, no action is taken. Caution: Make sure you call update on the collection after doing this, or the item will have been created but the collection record will not refer to it.

Throws:

SQLException

AuthorizeException

findAll

Iterator<Item> findAll(Context context)
                       throws SQLException

Get all the items in the archive. Only items with the "in archive" flag set are included. The order of the list is indeterminate.

Parameters:

context - DSpace context object

Returns:

an iterator over the items in the archive.

Throws:

SQLException

findAllUnfiltered

Iterator<Item> findAllUnfiltered(Context context)
                                 throws SQLException

Get all "final" items in the archive, both archived ("in archive" flag) or withdrawn items are included. The order of the list is indeterminate.

Parameters:

context - DSpace context object

Returns:

an iterator over the items in the archive.

Throws:

SQLException

findBySubmitter

Iterator<Item> findBySubmitter(Context context,
                             EPerson eperson)
                               throws SQLException

Find all the items in the archive by a given submitter. The order is indeterminate. Only items with the "in archive" flag set are included.

Parameters:

context - DSpace context object

eperson - the submitter

Returns:

an iterator over the items submitted by eperson

Throws:

SQLException

findBySubmitterDateSorted

Iterator<Item> findBySubmitterDateSorted(Context context,
                                       EPerson eperson,
                                       Integer limit)
                                         throws SQLException

Retrieve the list of Items submitted by eperson, ordered by recently submitted, optionally limitable

Parameters:

context -

eperson -

limit - a positive integer to limit, -1 or null for unlimited

Returns:

Throws:

SQLException

findByCollection

Iterator<Item> findByCollection(Context context,
                              Collection collection)
                                throws SQLException

Get all the items in this collection. The order is indeterminate.

Returns:

an iterator over the items in the collection.

Throws:

SQLException

findByCollection

Iterator<Item> findByCollection(Context context,
                              Collection collection,
                              Integer limit,
                              Integer offset)
                                throws SQLException

Get all the items in this collection. The order is indeterminate.

Returns:

an iterator over the items in the collection.

Throws:

SQLException

findInArchiveOrWithdrawnDiscoverableModifiedSince

Iterator<Item> findInArchiveOrWithdrawnDiscoverableModifiedSince(Context context,
                                                               Date since)
                                                                 throws SQLException

Get all Items installed or withdrawn, discoverable, and modified since a Date.

Parameters:

context -

since - earliest interesting last-modified date, or null for no date test.

Returns:

Throws:

SQLException

findAllByCollection

Iterator<Item> findAllByCollection(Context context,
                                 Collection collection)
                                   throws SQLException

Get all the items in this collection. The order is indeterminate.

Returns:

an iterator over the items in the collection.

Throws:

SQLException

isIn

boolean isIn(Item item,
           Collection collection)
             throws SQLException

See whether this Item is contained by a given Collection.

Parameters:

collection -

Returns:

true if collection contains this Item.

Throws:

SQLException

getCommunities

List<Community> getCommunities(Context context,
                             Item item)
                               throws SQLException

Get the communities this item is in. Returns an unordered array of the communities that house the collections this item is in, including parent communities of the owning collections.

Returns:

the communities this item is in.

Throws:

SQLException

getBundles

List<Bundle> getBundles(Item item,
                      String name)
                        throws SQLException

Get the bundles matching a bundle name (name corresponds roughly to type)

Parameters:

name - name of bundle (ORIGINAL/TEXT/THUMBNAIL)

Returns:

the bundles in an unordered array

Throws:

SQLException

addBundle

void addBundle(Context context,
             Item item,
             Bundle bundle)
               throws SQLException,
                      AuthorizeException

Add an existing bundle to this item. This has immediate effect.

Parameters:

bundle - the bundle to add

Throws:

SQLException

AuthorizeException

removeBundle

void removeBundle(Context context,
                Item item,
                Bundle bundle)
                  throws SQLException,
                         AuthorizeException,
                         IOException

Remove a bundle. This may result in the bundle being deleted, if the bundle is orphaned.

Parameters:

bundle - the bundle to remove

Throws:

SQLException

AuthorizeException

IOException

removeAllBundles

void removeAllBundles(Context context,
                    Item item)
                      throws AuthorizeException,
                             SQLException,
                             IOException

Remove all bundles linked to this item. This may result in the bundle being deleted, if the bundle is orphaned.

Parameters:

item - the item from which to remove our bundles

Throws:

SQLException

AuthorizeException

IOException

createSingleBitstream

Bitstream createSingleBitstream(Context context,
                              InputStream is,
                              Item item,
                              String name)
                                throws AuthorizeException,
                                       IOException,
                                       SQLException

Create a single bitstream in a new bundle. Provided as a convenience method for the most common use.

Parameters:

is - the stream to create the new bitstream from

name - is the name of the bundle (ORIGINAL, TEXT, THUMBNAIL)

Returns:

Bitstream that is created

Throws:

AuthorizeException

IOException

SQLException

createSingleBitstream

Bitstream createSingleBitstream(Context context,
                              InputStream is,
                              Item item)
                                throws AuthorizeException,
                                       IOException,
                                       SQLException

Convenience method, calls createSingleBitstream() with name "ORIGINAL"

Parameters:

is - InputStream

Returns:

created bitstream

Throws:

AuthorizeException

IOException

SQLException

getNonInternalBitstreams

List<Bitstream> getNonInternalBitstreams(Context context,
                                       Item item)
                                         throws SQLException

Get all non-internal bitstreams in the item. This is mainly used for auditing for provenance messages and adding format.* DC values. The order is indeterminate.

Returns:

non-internal bitstreams.

Throws:

SQLException

removeDSpaceLicense

void removeDSpaceLicense(Context context,
                       Item item)
                         throws SQLException,
                                AuthorizeException,
                                IOException

Remove just the DSpace license from an item This is useful to update the current DSpace license, in case the user must accept the DSpace license again (either the item was rejected, or resumed after saving)

This method is used by the org.dspace.submit.step.LicenseStep class

Throws:

SQLException

AuthorizeException

IOException

removeLicenses

void removeLicenses(Context context,
                  Item item)
                    throws SQLException,
                           AuthorizeException,
                           IOException

Remove all licenses from an item - it was rejected

Throws:

SQLException

AuthorizeException

IOException

withdraw

void withdraw(Context context,
            Item item)
              throws SQLException,
                     AuthorizeException

Withdraw the item from the archive. It is kept in place, and the content and metadata are not deleted, but it is not publicly accessible.

Throws:

SQLException

AuthorizeException

reinstate

void reinstate(Context context,
             Item item)
               throws SQLException,
                      AuthorizeException

Reinstate a withdrawn item

Throws:

SQLException

AuthorizeException

isOwningCollection

boolean isOwningCollection(Item item,
                         Collection collection)

Return true if this Collection 'owns' this item

Parameters:

collection - Collection

Returns:

true if this Collection owns this item

replaceAllItemPolicies

void replaceAllItemPolicies(Context context,
                          Item item,
                          List<ResourcePolicy> newpolicies)
                            throws SQLException,
                                   AuthorizeException

remove all of the policies for item and replace them with a new list of policies

Parameters:

newpolicies - - this will be all of the new policies for the item and its contents

Throws:

SQLException

AuthorizeException

replaceAllBitstreamPolicies

void replaceAllBitstreamPolicies(Context context,
                               Item item,
                               List<ResourcePolicy> newpolicies)
                                 throws SQLException,
                                        AuthorizeException

remove all of the policies for item's bitstreams and bundles and replace them with a new list of policies

Parameters:

newpolicies - - this will be all of the new policies for the bundle and bitstream contents

Throws:

SQLException

AuthorizeException

removeGroupPolicies

void removeGroupPolicies(Context context,
                       Item item,
                       Group group)
                         throws SQLException,
                                AuthorizeException

remove all of the policies for item's bitstreams and bundles that belong to a given Group

Parameters:

group - Group referenced by policies that needs to be removed

Throws:

SQLException

AuthorizeException

inheritCollectionDefaultPolicies

void inheritCollectionDefaultPolicies(Context context,
                                    Item item,
                                    Collection collection)
                                      throws SQLException,
                                             AuthorizeException

remove all policies on an item and its contents, and replace them with the DEFAULT_ITEM_READ and DEFAULT_BITSTREAM_READ policies belonging to the collection.

Parameters:

collection - Collection

Throws:

SQLException - if an SQL error or if no default policies found. It's a bit draconian, but default policies must be enforced.

AuthorizeException

adjustBundleBitstreamPolicies

void adjustBundleBitstreamPolicies(Context context,
                                 Item item,
                                 Collection collection)
                                   throws SQLException,
                                          AuthorizeException

Throws:

SQLException

AuthorizeException

adjustItemPolicies

void adjustItemPolicies(Context context,
                      Item item,
                      Collection collection)
                        throws SQLException,
                               AuthorizeException

Throws:

SQLException

AuthorizeException

move

void move(Context context,
        Item item,
        Collection from,
        Collection to)
          throws SQLException,
                 AuthorizeException,
                 IOException

Moves the item from one collection to another one

Throws:

SQLException

AuthorizeException

IOException

move

void move(Context context,
        Item item,
        Collection from,
        Collection to,
        boolean inheritDefaultPolicies)
          throws SQLException,
                 AuthorizeException,
                 IOException

Moves the item from one collection to another one

Throws:

SQLException

AuthorizeException

IOException

hasUploadedFiles

boolean hasUploadedFiles(Item item)
                         throws SQLException

Check the bundle ORIGINAL to see if there are any uploaded files

Returns:

true if there is a bundle named ORIGINAL with one or more bitstreams inside

Throws:

SQLException

getCollectionsNotLinked

List<Collection> getCollectionsNotLinked(Context context,
                                       Item item)
                                         throws SQLException

Get the collections this item is not in.

Returns:

the collections this item is not in, if any.

Throws:

SQLException

canEdit

boolean canEdit(Context context,
              Item item)
                throws SQLException

return TRUE if context's user can edit item, false otherwise

Returns:

boolean true = current user can edit item

Throws:

SQLException

findByMetadataField

Iterator<Item> findByMetadataField(Context context,
                                 String schema,
                                 String element,
                                 String qualifier,
                                 String value)
                                   throws SQLException,
                                          AuthorizeException,
                                          IOException

Returns an iterator of Items possessing the passed metadata field, or only those matching the passed value, if value is not Item.ANY

Parameters:

context - DSpace context object

schema - metadata field schema

element - metadata field element

qualifier - metadata field qualifier

value - field value or Item.ANY to match any value

Returns:

an iterator over the items matching that authority value

Throws:

SQLException, - AuthorizeException, IOException

SQLException

AuthorizeException

IOException

findByMetadataQuery

Iterator<Item> findByMetadataQuery(Context context,
                                 List<List<MetadataField>> listFieldList,
                                 List<String> query_op,
                                 List<String> query_val,
                                 List<UUID> collectionUuids,
                                 String regexClause,
                                 int offset,
                                 int limit)
                                   throws SQLException,
                                          AuthorizeException,
                                          IOException

Throws:

SQLException

AuthorizeException

IOException

findByAuthorityValue

Iterator<Item> findByAuthorityValue(Context context,
                                  String schema,
                                  String element,
                                  String qualifier,
                                  String value)
                                    throws SQLException,
                                           AuthorizeException,
                                           IOException

Find all the items in the archive with a given authority key value in the indicated metadata field.

Parameters:

context - DSpace context object

schema - metadata field schema

element - metadata field element

qualifier - metadata field qualifier

value - the value of authority key to look for

Returns:

an iterator over the items matching that authority value

Throws:

SQLException, - AuthorizeException, IOException

SQLException

AuthorizeException

IOException

findByMetadataFieldAuthority

Iterator<Item> findByMetadataFieldAuthority(Context context,
                                          String mdString,
                                          String authority)
                                            throws SQLException,
                                                   AuthorizeException

Throws:

SQLException

AuthorizeException

isItemListedForUser

boolean isItemListedForUser(Context context,
                          Item item)

Service method for knowing if this Item should be visible in the item list. Items only show up in the "item list" if the user has READ permission and if the Item isn't flagged as unlisted.

Parameters:

context -

item -

Returns:

countItems

int countItems(Context context,
             Collection collection)
               throws SQLException

counts items in the given collection

Returns:

total items

Throws:

SQLException

findByLastModifiedSince

Iterator<Item> findByLastModifiedSince(Context context,
                                     Date last)
                                       throws SQLException

Find all Items modified since a Date.

Parameters:

context -

last - Earliest interesting last-modified date.

Returns:

Throws:

SQLException

countItems

int countItems(Context context,
             Community community)
               throws SQLException

counts items in the given community

Returns:

total items

Throws:

SQLException

countTotal

int countTotal(Context context)
               throws SQLException

Throws:

SQLException

countNotArchivedItems

int countNotArchivedItems(Context context)
                          throws SQLException

Throws:

SQLException

countWithdrawnItems

int countWithdrawnItems(Context context)
                        throws SQLException

Throws:

SQLException