ItemServiceImpl (DSpace Kernel :: API and Implementation 6.0-rc2 API)

java.lang.Object
- org.dspace.content.DSpaceObjectServiceImpl<Item>
- - org.dspace.content.ItemServiceImpl

All Implemented Interfaces:

DSpaceObjectLegacySupportService<Item>, DSpaceObjectService<Item>, ItemService
```
public class ItemServiceImpl
extends DSpaceObjectServiceImpl<Item>
implements ItemService
```
Service implementation for the Item object. This class is responsible for all business logic calls for the Item 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 BitstreamFormatService`	`bitstreamFormatService`
`protected BitstreamService`	`bitstreamService`
`protected BundleService`	`bundleService`
`protected CollectionService`	`collectionService`
`protected CommunityService`	`communityService`
`protected HarvestedItemService`	`harvestedItemService`
`protected IdentifierService`	`identifierService`
`protected InstallItemService`	`installItemService`
`protected ItemDAO`	`itemDAO`
`protected MetadataSchemaService`	`metadataSchemaService`
`protected ResourcePolicyService`	`resourcePolicyService`
`protected VersioningService`	`versioningService`

Fields inherited from class org.dspace.content.DSpaceObjectServiceImpl
choiceAuthorityService, handleService, metadataAuthorityService, metadataFieldService, metadataValueService

Constructor Summary

Constructors
Modifier Constructor and Description

protected ItemServiceImpl()

Constructors
Modifier	Constructor and Description
`protected`	`ItemServiceImpl()`

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)` counts all items not in archive
`int`	`countTotal(Context context)` counts all items
`int`	`countWithdrawnItems(Context context)` counts all withdrawn items
`Item`	`create(Context context, WorkspaceItem workspaceItem)` Create a new item, with a new internal ID.
`protected Item`	`createItem(Context context)`
`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.
`void`	`delete(Context context, Item item)`
`protected void`	`deleteBundle(Context context, Item item, Bundle b)`
`protected List<ResourcePolicy>`	`filterPoliciesToAdd(Context context, List<ResourcePolicy> defaultCollectionPolicies, DSpaceObject dso)`
`Item`	`find(Context context, UUID id)` Generic find for when the precise type of a DSO is not known, just the a pair of type number and database ID.
`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.
`Item`	`findByIdOrLegacyId(Context context, String id)`
`Iterator<Item>`	`findByLastModifiedSince(Context context, Date last)` Find all Items modified since a Date.
`Item`	`findByLegacyId(Context context, int id)` Generic find for when the precise type of a DSO is not known, just the a pair of type number and database ID.
`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.
`DSpaceObject`	`getAdminObject(Context context, Item item, int action)` Return the dspace object where an ADMIN action right is sufficient to grant the initial authorize check.
`protected void`	`getAuthoritiesAndConfidences(String fieldKey, Collection collection, List<String> values, List<String> authorities, List<Integer> confidences, int i)`
`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.
`DSpaceObject`	`getParentObject(Context context, Item item)` Return the dspace object that "own" the current object in the hierarchy.
`int`	`getSupportsTypeConstant()` Returns the Constants which this service supports
`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
`protected void`	`rawDelete(Context context, Item item)`
`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
`protected void`	`removeVersion(Context context, Item item)`
`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`	`update(Context context, Item item)`
`void`	`updateLastModified(Context context, Item item)`
`void`	`withdraw(Context context, Item item)` Withdraw the item from the archive.

Methods inherited from class org.dspace.content.DSpaceObjectServiceImpl
addMetadata, addMetadata, addMetadata, addMetadata, addMetadata, addMetadata, addMetadata, addMetadata, clearMetadata, getElements, getElementsFilled, getIdentifiers, getMDValueByField, getMDValueByLegacyField, getMetadata, getMetadata, getMetadata, getMetadata, getMetadataByMetadataString, getMetadataFirstValue, getMetadataValuePlace, getName, getTypeText, match, removeMetadataValues, setMetadataSingleValue

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.dspace.content.service.DSpaceObjectService
addMetadata, addMetadata, addMetadata, addMetadata, addMetadata, addMetadata, addMetadata, addMetadata, clearMetadata, getIdentifiers, getMetadata, getMetadata, getMetadata, getMetadata, getMetadataByMetadataString, getMetadataFirstValue, getName, getTypeText, removeMetadataValues, setMetadataSingleValue

- Field Detail
  - itemDAO
```
@Autowired(required=true)
protected ItemDAO itemDAO
```
  - communityService
```
@Autowired(required=true)
protected CommunityService communityService
```
  - authorizeService
```
@Autowired(required=true)
protected AuthorizeService authorizeService
```
  - bundleService
```
@Autowired(required=true)
protected BundleService bundleService
```
  - bitstreamFormatService
```
@Autowired(required=true)
protected BitstreamFormatService bitstreamFormatService
```
  - metadataSchemaService
```
@Autowired(required=true)
protected MetadataSchemaService metadataSchemaService
```
  - bitstreamService
```
@Autowired(required=true)
protected BitstreamService bitstreamService
```
  - installItemService
```
@Autowired(required=true)
protected InstallItemService installItemService
```
  - resourcePolicyService
```
@Autowired(required=true)
protected ResourcePolicyService resourcePolicyService
```
  - collectionService
```
@Autowired(required=true)
protected CollectionService collectionService
```
  - identifierService
```
@Autowired(required=true)
protected IdentifierService identifierService
```
  - versioningService
```
@Autowired(required=true)
protected VersioningService versioningService
```
  - harvestedItemService
```
@Autowired(required=true)
protected HarvestedItemService harvestedItemService
```
- Constructor Detail
  - ItemServiceImpl
```
protected ItemServiceImpl()
```
- Method Detail
  - getThumbnail
```
public Thumbnail getThumbnail(Context context,
                     Item item,
                     boolean requireOriginal)
                       throws SQLException
```
    Specified by:
    
    getThumbnail in interface ItemService
    
    Throws:
    
    SQLException
  - find
```
public Item find(Context context,
        UUID id)
          throws SQLException
```
    Description copied from interface: DSpaceObjectService
    
    Generic find for when the precise type of a DSO is not known, just the a pair of type number and database ID.
    
    Specified by:
    
    find in interface DSpaceObjectService<Item>
    
    Parameters:
    context - - the context
    id - - id within table of type'd objects
    
    Returns:
    the object found, or null if it does not exist.
    
    Throws:
    
    SQLException - only upon failure accessing the database.
  - create
```
public Item create(Context context,
          WorkspaceItem workspaceItem)
            throws SQLException,
                   AuthorizeException
```
    Description copied from interface: ItemService
    
    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.
    
    Specified by:
    
    create in interface ItemService
    
    Parameters:
    context - DSpace context object
    workspaceItem - in progress workspace item
    
    Returns:
    the newly created item
    
    Throws:
    
    SQLException - if database error
    
    AuthorizeException - if authorization error
  - createTemplateItem
```
public Item createTemplateItem(Context context,
                      Collection collection)
                        throws SQLException,
                               AuthorizeException
```
    Description copied from interface: ItemService
    
    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.
    
    Specified by:
    
    createTemplateItem in interface ItemService
    
    Parameters:
    context - DSpace context object
    collection - Collection (parent)
    
    Returns:
    Item
    
    Throws:
    
    SQLException - if database error
    
    AuthorizeException - if authorization error
  - findAll
```
public Iterator<Item> findAll(Context context)
                       throws SQLException
```
    Description copied from interface: ItemService
    
    Get all the items in the archive. Only items with the "in archive" flag set are included. The order of the list is indeterminate.
    
    Specified by:
    
    findAll in interface ItemService
    
    Parameters:
    context - DSpace context object
    
    Returns:
    an iterator over the items in the archive.
    
    Throws:
    
    SQLException - if database error
  - findAllUnfiltered
```
public Iterator<Item> findAllUnfiltered(Context context)
                                 throws SQLException
```
    Description copied from interface: ItemService
    
    Get all "final" items in the archive, both archived ("in archive" flag) or withdrawn items are included. The order of the list is indeterminate.
    
    Specified by:
    
    findAllUnfiltered in interface ItemService
    
    Parameters:
    context - DSpace context object
    
    Returns:
    an iterator over the items in the archive.
    
    Throws:
    
    SQLException - if database error
  - findBySubmitter
```
public Iterator<Item> findBySubmitter(Context context,
                             EPerson eperson)
                               throws SQLException
```
    Description copied from interface: ItemService
    
    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.
    
    Specified by:
    
    findBySubmitter in interface ItemService
    
    Parameters:
    context - DSpace context object
    eperson - the submitter
    
    Returns:
    an iterator over the items submitted by eperson
    
    Throws:
    
    SQLException - if database error
  - findBySubmitterDateSorted
```
public Iterator<Item> findBySubmitterDateSorted(Context context,
                                       EPerson eperson,
                                       Integer limit)
                                         throws SQLException
```
    Description copied from interface: ItemService
    
    Retrieve the list of Items submitted by eperson, ordered by recently submitted, optionally limitable
    
    Specified by:
    
    findBySubmitterDateSorted in interface ItemService
    
    Parameters:
    context - context
    eperson - eperson
    limit - a positive integer to limit, -1 or null for unlimited
    
    Returns:
    
    Throws:
    
    SQLException - if database error
  - findByCollection
```
public Iterator<Item> findByCollection(Context context,
                              Collection collection)
                                throws SQLException
```
    Description copied from interface: ItemService
    
    Get all the items in this collection. The order is indeterminate.
    
    Specified by:
    
    findByCollection in interface ItemService
    
    Parameters:
    context - DSpace context object
    collection - Collection (parent)
    
    Returns:
    an iterator over the items in the collection.
    
    Throws:
    
    SQLException - if database error
  - findByCollection
```
public Iterator<Item> findByCollection(Context context,
                              Collection collection,
                              Integer limit,
                              Integer offset)
                                throws SQLException
```
    Description copied from interface: ItemService
    
    Get all the items in this collection. The order is indeterminate.
    
    Specified by:
    
    findByCollection in interface ItemService
    
    Parameters:
    context - DSpace context object
    collection - Collection (parent)
    limit - limited number of items
    offset - offset value
    
    Returns:
    an iterator over the items in the collection.
    
    Throws:
    
    SQLException - if database error
  - findAllByCollection
```
public Iterator<Item> findAllByCollection(Context context,
                                 Collection collection)
                                   throws SQLException
```
    Description copied from interface: ItemService
    
    Get all the items in this collection. The order is indeterminate.
    
    Specified by:
    
    findAllByCollection in interface ItemService
    
    Parameters:
    context - DSpace context object
    collection - Collection (parent)
    
    Returns:
    an iterator over the items in the collection.
    
    Throws:
    
    SQLException - if database error
  - findInArchiveOrWithdrawnDiscoverableModifiedSince
```
public Iterator<Item> findInArchiveOrWithdrawnDiscoverableModifiedSince(Context context,
                                                               Date since)
                                                                 throws SQLException
```
    Description copied from interface: ItemService
    
    Get all Items installed or withdrawn, discoverable, and modified since a Date.
    
    Specified by:
    
    findInArchiveOrWithdrawnDiscoverableModifiedSince in interface ItemService
    
    Parameters:
    context - context
    since - earliest interesting last-modified date, or null for no date test.
    
    Returns:
    an iterator over the items in the collection.
    
    Throws:
    
    SQLException - if database error
  - updateLastModified
```
public void updateLastModified(Context context,
                      Item item)
                        throws SQLException,
                               AuthorizeException
```
    Specified by:
    
    updateLastModified in interface DSpaceObjectService<Item>
    
    Throws:
    
    SQLException
    
    AuthorizeException
  - isIn
```
public boolean isIn(Item item,
           Collection collection)
             throws SQLException
```
    Description copied from interface: ItemService
    
    See whether this Item is contained by a given Collection.
    
    Specified by:
    
    isIn in interface ItemService
    
    Parameters:
    item - Item
    collection - Collection (parent
    
    Returns:
    true if collection contains this Item.
    
    Throws:
    
    SQLException - if database error
  - getCommunities
```
public List<Community> getCommunities(Context context,
                             Item item)
                               throws SQLException
```
    Description copied from interface: ItemService
    
    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.
    
    Specified by:
    
    getCommunities in interface ItemService
    
    Parameters:
    context - DSpace context object
    item - Item
    
    Returns:
    the communities this item is in.
    
    Throws:
    
    SQLException - if database error
  - getBundles
```
public List<Bundle> getBundles(Item item,
                      String name)
                        throws SQLException
```
    Description copied from interface: ItemService
    
    Get the bundles matching a bundle name (name corresponds roughly to type)
    
    Specified by:
    
    getBundles in interface ItemService
    
    Parameters:
    item - Item
    name - name of bundle (ORIGINAL/TEXT/THUMBNAIL)
    
    Returns:
    the bundles in an unordered array
    
    Throws:
    
    SQLException - if database error
  - addBundle
```
public void addBundle(Context context,
             Item item,
             Bundle bundle)
               throws SQLException,
                      AuthorizeException
```
    Description copied from interface: ItemService
    
    Add an existing bundle to this item. This has immediate effect.
    
    Specified by:
    
    addBundle in interface ItemService
    
    Parameters:
    context - DSpace context object
    item - Item
    bundle - the bundle to add
    
    Throws:
    
    SQLException - if database error
    
    AuthorizeException - if authorization error
  - removeBundle
```
public void removeBundle(Context context,
                Item item,
                Bundle bundle)
                  throws SQLException,
                         AuthorizeException,
                         IOException
```
    Description copied from interface: ItemService
    
    Remove a bundle. This may result in the bundle being deleted, if the bundle is orphaned.
    
    Specified by:
    
    removeBundle in interface ItemService
    
    Parameters:
    context - DSpace context object
    item - Item
    bundle - the bundle to remove
    
    Throws:
    
    SQLException - if database error
    
    AuthorizeException - if authorization error
    
    IOException - if IO error
  - createSingleBitstream
```
public Bitstream createSingleBitstream(Context context,
                              InputStream is,
                              Item item,
                              String name)
                                throws AuthorizeException,
                                       IOException,
                                       SQLException
```
    Description copied from interface: ItemService
    
    Create a single bitstream in a new bundle. Provided as a convenience method for the most common use.
    
    Specified by:
    
    createSingleBitstream in interface ItemService
    
    Parameters:
    context - DSpace context object
    is - the stream to create the new bitstream from
    item - Item
    name - is the name of the bundle (ORIGINAL, TEXT, THUMBNAIL)
    
    Returns:
    Bitstream that is created
    
    Throws:
    
    AuthorizeException - if authorization error
    
    IOException - if IO error
    
    SQLException - if database error
  - createSingleBitstream
```
public Bitstream createSingleBitstream(Context context,
                              InputStream is,
                              Item item)
                                throws AuthorizeException,
                                       IOException,
                                       SQLException
```
    Description copied from interface: ItemService
    
    Convenience method, calls createSingleBitstream() with name "ORIGINAL"
    
    Specified by:
    
    createSingleBitstream in interface ItemService
    
    Parameters:
    context - DSpace context object
    is - InputStream
    item - Item
    
    Returns:
    created bitstream
    
    Throws:
    
    AuthorizeException - if authorization error
    
    IOException - if IO error
    
    SQLException - if database error
  - getNonInternalBitstreams
```
public List<Bitstream> getNonInternalBitstreams(Context context,
                                       Item item)
                                         throws SQLException
```
    Description copied from interface: ItemService
    
    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.
    
    Specified by:
    
    getNonInternalBitstreams in interface ItemService
    
    Parameters:
    context - DSpace context object
    item - Item
    
    Returns:
    non-internal bitstreams.
    
    Throws:
    
    SQLException - if database error
  - createItem
```
protected Item createItem(Context context)
                   throws SQLException,
                          AuthorizeException
```
    Throws:
    
    SQLException
    
    AuthorizeException
  - removeDSpaceLicense
```
public void removeDSpaceLicense(Context context,
                       Item item)
                         throws SQLException,
                                AuthorizeException,
                                IOException
```
    Description copied from interface: ItemService
    
    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
    
    Specified by:
    
    removeDSpaceLicense in interface ItemService
    
    Parameters:
    context - DSpace context object
    item - Item
    
    Throws:
    
    SQLException - if database error
    
    AuthorizeException - if authorization error
    
    IOException - if IO error
  - removeLicenses
```
public void removeLicenses(Context context,
                  Item item)
                    throws SQLException,
                           AuthorizeException,
                           IOException
```
    Description copied from interface: ItemService
    
    Remove all licenses from an item - it was rejected
    
    Specified by:
    
    removeLicenses in interface ItemService
    
    Parameters:
    context - DSpace context object
    item - Item
    
    Throws:
    
    SQLException - if database error
    
    AuthorizeException - if authorization error
    
    IOException - if IO error
  - update
```
public void update(Context context,
          Item item)
            throws SQLException,
                   AuthorizeException
```
    Specified by:
    
    update in interface DSpaceObjectService<Item>
    
    Overrides:
    
    update in class DSpaceObjectServiceImpl<Item>
    
    Throws:
    
    SQLException
    
    AuthorizeException
  - withdraw
```
public void withdraw(Context context,
            Item item)
              throws SQLException,
                     AuthorizeException
```
    Description copied from interface: ItemService
    
    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.
    
    Specified by:
    
    withdraw in interface ItemService
    
    Parameters:
    context - DSpace context object
    item - Item
    
    Throws:
    
    SQLException - if database error
    
    AuthorizeException - if authorization error
  - reinstate
```
public void reinstate(Context context,
             Item item)
               throws SQLException,
                      AuthorizeException
```
    Description copied from interface: ItemService
    
    Reinstate a withdrawn item
    
    Specified by:
    
    reinstate in interface ItemService
    
    Parameters:
    context - DSpace context object
    item - Item
    
    Throws:
    
    SQLException - if database error
    
    AuthorizeException - if authorization error
  - delete
```
public void delete(Context context,
          Item item)
            throws SQLException,
                   AuthorizeException,
                   IOException
```
    Specified by:
    
    delete in interface DSpaceObjectService<Item>
    
    Throws:
    
    SQLException
    
    AuthorizeException
    
    IOException
  - getSupportsTypeConstant
```
public int getSupportsTypeConstant()
```
    Description copied from interface: DSpaceObjectService
    
    Returns the Constants which this service supports
    
    Specified by:
    
    getSupportsTypeConstant in interface DSpaceObjectLegacySupportService<Item>
    
    Specified by:
    
    getSupportsTypeConstant in interface DSpaceObjectService<Item>
    
    Returns:
    a org.dspace.core.Constants that represents a DSpaceObjct type
  - rawDelete
```
protected void rawDelete(Context context,
             Item item)
                  throws AuthorizeException,
                         SQLException,
                         IOException
```
    Throws:
    
    AuthorizeException
    
    SQLException
    
    IOException
  - removeAllBundles
```
public void removeAllBundles(Context context,
                    Item item)
                      throws AuthorizeException,
                             SQLException,
                             IOException
```
    Description copied from interface: ItemService
    
    Remove all bundles linked to this item. This may result in the bundle being deleted, if the bundle is orphaned.
    
    Specified by:
    
    removeAllBundles in interface ItemService
    
    Parameters:
    context - DSpace context object
    item - the item from which to remove our bundles
    
    Throws:
    
    AuthorizeException - if authorization error
    
    SQLException - if database error
    
    IOException - if IO error
  - deleteBundle
```
protected void deleteBundle(Context context,
                Item item,
                Bundle b)
                     throws AuthorizeException,
                            SQLException,
                            IOException
```
    Throws:
    
    AuthorizeException
    
    SQLException
    
    IOException
  - removeVersion
```
protected void removeVersion(Context context,
                 Item item)
                      throws AuthorizeException,
                             SQLException
```
    Throws:
    
    AuthorizeException
    
    SQLException
  - isOwningCollection
```
public boolean isOwningCollection(Item item,
                         Collection collection)
```
    Description copied from interface: ItemService
    
    Return true if this Collection 'owns' this item
    
    Specified by:
    
    isOwningCollection in interface ItemService
    
    Parameters:
    item - Item
    collection - Collection
    
    Returns:
    true if this Collection owns this item
  - replaceAllItemPolicies
```
public void replaceAllItemPolicies(Context context,
                          Item item,
                          List<ResourcePolicy> newpolicies)
                            throws SQLException,
                                   AuthorizeException
```
    Description copied from interface: ItemService
    
    remove all of the policies for item and replace them with a new list of policies
    
    Specified by:
    
    replaceAllItemPolicies in interface ItemService
    
    Parameters:
    context - DSpace context object
    item - Item
    newpolicies - - this will be all of the new policies for the item and its contents
    
    Throws:
    
    SQLException - if database error
    
    AuthorizeException - if authorization error
  - replaceAllBitstreamPolicies
```
public void replaceAllBitstreamPolicies(Context context,
                               Item item,
                               List<ResourcePolicy> newpolicies)
                                 throws SQLException,
                                        AuthorizeException
```
    Description copied from interface: ItemService
    
    remove all of the policies for item's bitstreams and bundles and replace them with a new list of policies
    
    Specified by:
    
    replaceAllBitstreamPolicies in interface ItemService
    
    Parameters:
    context - DSpace context object
    item - Item
    newpolicies - - this will be all of the new policies for the bundle and bitstream contents
    
    Throws:
    
    SQLException - if database error
    
    AuthorizeException - if authorization error
  - removeGroupPolicies
```
public void removeGroupPolicies(Context context,
                       Item item,
                       Group group)
                         throws SQLException,
                                AuthorizeException
```
    Description copied from interface: ItemService
    
    remove all of the policies for item's bitstreams and bundles that belong to a given Group
    
    Specified by:
    
    removeGroupPolicies in interface ItemService
    
    Parameters:
    context - DSpace context object
    item - Item
    group - Group referenced by policies that needs to be removed
    
    Throws:
    
    SQLException - if database error
    
    AuthorizeException - if authorization error
  - inheritCollectionDefaultPolicies
```
public void inheritCollectionDefaultPolicies(Context context,
                                    Item item,
                                    Collection collection)
                                      throws SQLException,
                                             AuthorizeException
```
    Description copied from interface: ItemService
    
    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.
    
    Specified by:
    
    inheritCollectionDefaultPolicies in interface ItemService
    
    Parameters:
    context - DSpace context object
    item - Item
    collection - Collection
    
    Throws:
    
    SQLException - if database error if an SQL error or if no default policies found. It's a bit draconian, but default policies must be enforced.
    
    AuthorizeException - if authorization error
  - adjustBundleBitstreamPolicies
```
public void adjustBundleBitstreamPolicies(Context context,
                                 Item item,
                                 Collection collection)
                                   throws SQLException,
                                          AuthorizeException
```
    Specified by:
    
    adjustBundleBitstreamPolicies in interface ItemService
    
    Throws:
    
    SQLException
    
    AuthorizeException
  - adjustItemPolicies
```
public void adjustItemPolicies(Context context,
                      Item item,
                      Collection collection)
                        throws SQLException,
                               AuthorizeException
```
    Specified by:
    
    adjustItemPolicies in interface ItemService
    
    Throws:
    
    SQLException
    
    AuthorizeException
  - move
```
public void move(Context context,
        Item item,
        Collection from,
        Collection to)
          throws SQLException,
                 AuthorizeException,
                 IOException
```
    Description copied from interface: ItemService
    
    Moves the item from one collection to another one
    
    Specified by:
    
    move in interface ItemService
    
    Parameters:
    context - DSpace context object
    item - Item
    from - Collection to move from
    to - Collection to move to
    
    Throws:
    
    SQLException - if database error
    
    AuthorizeException - if authorization error
    
    IOException - if IO error
  - move
```
public void move(Context context,
        Item item,
        Collection from,
        Collection to,
        boolean inheritDefaultPolicies)
          throws SQLException,
                 AuthorizeException,
                 IOException
```
    Description copied from interface: ItemService
    
    Moves the item from one collection to another one
    
    Specified by:
    
    move in interface ItemService
    
    Parameters:
    context - DSpace context object
    item - Item
    from - Collection to move from
    to - Collection to move to
    inheritDefaultPolicies - whether to inherit policies from new collection
    
    Throws:
    
    SQLException - if database error
    
    AuthorizeException - if authorization error
    
    IOException - if IO error
  - hasUploadedFiles
```
public boolean hasUploadedFiles(Item item)
                         throws SQLException
```
    Description copied from interface: ItemService
    
    Check the bundle ORIGINAL to see if there are any uploaded files
    
    Specified by:
    
    hasUploadedFiles in interface ItemService
    
    Parameters:
    item - Item
    
    Returns:
    true if there is a bundle named ORIGINAL with one or more bitstreams inside
    
    Throws:
    
    SQLException - if database error
  - getCollectionsNotLinked
```
public List<Collection> getCollectionsNotLinked(Context context,
                                       Item item)
                                         throws SQLException
```
    Description copied from interface: ItemService
    
    Get the collections this item is not in.
    
    Specified by:
    
    getCollectionsNotLinked in interface ItemService
    
    Parameters:
    context - DSpace context object
    item - Item
    
    Returns:
    the collections this item is not in, if any.
    
    Throws:
    
    SQLException - if database error
  - canEdit
```
public boolean canEdit(Context context,
              Item item)
                throws SQLException
```
    Description copied from interface: ItemService
    
    return TRUE if context's user can edit item, false otherwise
    
    Specified by:
    
    canEdit in interface ItemService
    
    Parameters:
    context - DSpace context object
    item - Item
    
    Returns:
    boolean true = current user can edit item
    
    Throws:
    
    SQLException - if database error
  - filterPoliciesToAdd
```
protected List<ResourcePolicy> filterPoliciesToAdd(Context context,
                                       List<ResourcePolicy> defaultCollectionPolicies,
                                       DSpaceObject dso)
                                            throws SQLException,
                                                   AuthorizeException
```
    Throws:
    
    SQLException
    
    AuthorizeException
  - findByMetadataField
```
public 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
    
    Specified by:
    
    findByMetadataField in interface ItemService
    
    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 - if database error
    
    AuthorizeException - if authorization error
    
    IOException - if IO error
  - findByMetadataQuery
```
public 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
```
    Specified by:
    
    findByMetadataQuery in interface ItemService
    
    Throws:
    
    SQLException
    
    AuthorizeException
    
    IOException
  - getAdminObject
```
public DSpaceObject getAdminObject(Context context,
                          Item item,
                          int action)
                            throws SQLException
```
    Description copied from interface: DSpaceObjectService
    
    Return the dspace object where an ADMIN action right is sufficient to grant the initial authorize check.
    Default behaviour is ADMIN right on the object grant right on all other action on the object itself. Subclass should override this method as needed.
    
    Specified by:
    
    getAdminObject in interface DSpaceObjectService<Item>
    
    Overrides:
    
    getAdminObject in class DSpaceObjectServiceImpl<Item>
    
    Parameters:
    context - DSpace context
    item - DSpaceObject
    action - ID of action being attempted, from org.dspace.core.Constants. The ADMIN action is not a valid parameter for this method, an IllegalArgumentException should be thrown
    
    Returns:
    the dspace object, if any, where an ADMIN action is sufficient to grant the original action
    
    Throws:
    
    SQLException - if database error
  - getParentObject
```
public DSpaceObject getParentObject(Context context,
                           Item item)
                             throws SQLException
```
    Description copied from interface: DSpaceObjectService
    
    Return the dspace object that "own" the current object in the hierarchy. Note that this method has a meaning slightly different from the getAdminObject because it is independent of the action but it is in a way related to it. It defines the "first" dspace object OTHER then the current one, where allowed ADMIN actions imply allowed ADMIN actions on the object self.
    
    Specified by:
    
    getParentObject in interface DSpaceObjectService<Item>
    
    Overrides:
    
    getParentObject in class DSpaceObjectServiceImpl<Item>
    
    Parameters:
    context - DSpace context
    item - DSpaceObject
    
    Returns:
    the dspace object that "own" the current object in the hierarchy
    
    Throws:
    
    SQLException - if database error
  - findByAuthorityValue
```
public Iterator<Item> findByAuthorityValue(Context context,
                                  String schema,
                                  String element,
                                  String qualifier,
                                  String value)
                                    throws SQLException,
                                           AuthorizeException
```
    Description copied from interface: ItemService
    
    Find all the items in the archive with a given authority key value in the indicated metadata field.
    
    Specified by:
    
    findByAuthorityValue in interface ItemService
    
    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 - if database error
    
    AuthorizeException - if authorization error
  - findByMetadataFieldAuthority
```
public Iterator<Item> findByMetadataFieldAuthority(Context context,
                                          String mdString,
                                          String authority)
                                            throws SQLException,
                                                   AuthorizeException
```
    Specified by:
    
    findByMetadataFieldAuthority in interface ItemService
    
    Throws:
    
    SQLException
    
    AuthorizeException
  - isItemListedForUser
```
public boolean isItemListedForUser(Context context,
                          Item item)
```
    Description copied from interface: ItemService
    
    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.
    
    Specified by:
    
    isItemListedForUser in interface ItemService
    
    Parameters:
    context - context
    item - item
    
    Returns:
    true or false
  - countItems
```
public int countItems(Context context,
             Collection collection)
               throws SQLException
```
    Description copied from interface: ItemService
    
    counts items in the given collection
    
    Specified by:
    
    countItems in interface ItemService
    
    Parameters:
    context - DSpace context object
    collection - Collection
    
    Returns:
    total items
    
    Throws:
    
    SQLException - if database error
  - countItems
```
public int countItems(Context context,
             Community community)
               throws SQLException
```
    Description copied from interface: ItemService
    
    counts items in the given community
    
    Specified by:
    
    countItems in interface ItemService
    
    Parameters:
    context - DSpace context object
    community - Community
    
    Returns:
    total items
    
    Throws:
    
    SQLException - if database error
  - getAuthoritiesAndConfidences
```
protected void getAuthoritiesAndConfidences(String fieldKey,
                                Collection collection,
                                List<String> values,
                                List<String> authorities,
                                List<Integer> confidences,
                                int i)
```
    Overrides:
    
    getAuthoritiesAndConfidences in class DSpaceObjectServiceImpl<Item>
  - findByIdOrLegacyId
```
public Item findByIdOrLegacyId(Context context,
                      String id)
                        throws SQLException
```
    Specified by:
    
    findByIdOrLegacyId in interface DSpaceObjectLegacySupportService<Item>
    
    Throws:
    
    SQLException
  - findByLegacyId
```
public Item findByLegacyId(Context context,
                  int id)
                    throws SQLException
```
    Description copied from interface: DSpaceObjectLegacySupportService
    
    Generic find for when the precise type of a DSO is not known, just the a pair of type number and database ID.
    
    Specified by:
    
    findByLegacyId in interface DSpaceObjectLegacySupportService<Item>
    
    Parameters:
    context - - the context
    id - - the legacy id within table of type'd objects
    
    Returns:
    the object found, or null if it does not exist.
    
    Throws:
    
    SQLException - only upon failure accessing the database.
  - findByLastModifiedSince
```
public Iterator<Item> findByLastModifiedSince(Context context,
                                     Date last)
                                       throws SQLException
```
    Description copied from interface: ItemService
    
    Find all Items modified since a Date.
    
    Specified by:
    
    findByLastModifiedSince in interface ItemService
    
    Parameters:
    context - context
    last - Earliest interesting last-modified date.
    
    Returns:
    iterator over items
    
    Throws:
    
    SQLException - if database error
  - countTotal
```
public int countTotal(Context context)
               throws SQLException
```
    Description copied from interface: ItemService
    
    counts all items
    
    Specified by:
    
    countTotal in interface ItemService
    
    Parameters:
    context - DSpace context object
    
    Returns:
    total items
    
    Throws:
    
    SQLException - if database error
  - countNotArchivedItems
```
public int countNotArchivedItems(Context context)
                          throws SQLException
```
    Description copied from interface: ItemService
    
    counts all items not in archive
    
    Specified by:
    
    countNotArchivedItems in interface ItemService
    
    Parameters:
    context - DSpace context object
    
    Returns:
    total items
    
    Throws:
    
    SQLException - if database error
  - countWithdrawnItems
```
public int countWithdrawnItems(Context context)
                        throws SQLException
```
    Description copied from interface: ItemService
    
    counts all withdrawn items
    
    Specified by:
    
    countWithdrawnItems in interface ItemService
    
    Parameters:
    context - DSpace context object
    
    Returns:
    total items
    
    Throws:
    
    SQLException - if database error

Class ItemServiceImpl

Field Summary

Fields inherited from class org.dspace.content.DSpaceObjectServiceImpl

Constructor Summary

Method Summary

Methods inherited from class org.dspace.content.DSpaceObjectServiceImpl

Methods inherited from class java.lang.Object

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

Field Detail

itemDAO

communityService

authorizeService

bundleService

bitstreamFormatService

metadataSchemaService

bitstreamService

installItemService

resourcePolicyService

collectionService

identifierService

versioningService

harvestedItemService

Constructor Detail

ItemServiceImpl

Method Detail

getThumbnail

find

create

createTemplateItem

findAll

findAllUnfiltered

findBySubmitter

findBySubmitterDateSorted

findByCollection

findByCollection

findAllByCollection

findInArchiveOrWithdrawnDiscoverableModifiedSince

updateLastModified

isIn

getCommunities

getBundles

addBundle

removeBundle

createSingleBitstream

createSingleBitstream

getNonInternalBitstreams

createItem

removeDSpaceLicense

removeLicenses

update

withdraw

reinstate

delete

getSupportsTypeConstant

rawDelete

removeAllBundles

deleteBundle

removeVersion

isOwningCollection

replaceAllItemPolicies

replaceAllBitstreamPolicies

removeGroupPolicies

inheritCollectionDefaultPolicies

adjustBundleBitstreamPolicies

adjustItemPolicies

move

move

hasUploadedFiles

getCollectionsNotLinked

canEdit

filterPoliciesToAdd

findByMetadataField

findByMetadataQuery

getAdminObject

getParentObject

findByAuthorityValue

findByMetadataFieldAuthority

isItemListedForUser

countItems

countItems