java.lang.Object
- org.dspace.content.DSpaceObjectServiceImpl<Collection>
- - org.dspace.content.CollectionServiceImpl

All Implemented Interfaces:

CollectionService, DSpaceObjectLegacySupportService<Collection>, DSpaceObjectService<Collection>
```
public class CollectionServiceImpl
extends DSpaceObjectServiceImpl<Collection>
implements CollectionService
```
Service implementation for the Collection object. This class is responsible for all business logic calls for the Collection 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	Description
`protected AuthorizeService`	`authorizeService`
`protected BitstreamService`	`bitstreamService`
`protected CollectionDAO`	`collectionDAO`
`protected CollectionRoleService`	`collectionRoleService`
`protected CommunityService`	`communityService`
`protected ConfigurationService`	`configurationService`
`protected GroupService`	`groupService`
`protected HarvestedCollectionService`	`harvestedCollectionService`
`protected IdentifierService`	`identifierService`
`protected ItemService`	`itemService`
`protected LicenseService`	`licenseService`
`protected ResourcePolicyService`	`resourcePolicyService`
`protected SearchService`	`searchService`
`protected SubscribeService`	`subscribeService`
`protected XmlWorkflowFactory`	`workflowFactory`
`protected WorkspaceItemService`	`workspaceItemService`

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

Fields inherited from interface org.dspace.content.service.DSpaceObjectService
MD_COPYRIGHT_TEXT, MD_INTRODUCTORY_TEXT, MD_LICENSE, MD_NAME, MD_PROVENANCE_DESCRIPTION, MD_SHORT_DESCRIPTION, MD_SIDEBAR_TEXT, MD_SOURCE, MD_USER_FORMAT_DESCRIPTION

Constructor Summary

Constructors
Modifier Constructor Description

protected CollectionServiceImpl()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`addItem(Context context, Collection collection, Item item)`	Add an item to the collection.
`void`	`canEdit(Context context, Collection collection)`
`void`	`canEdit(Context context, Collection collection, boolean useInheritance)`
`boolean`	`canEditBoolean(Context context, Collection collection)`
`boolean`	`canEditBoolean(Context context, Collection collection, boolean useInheritance)`
`int`	`countCollectionsWithSubmit(String q, Context context, Community community)`	Counts the number of Collection for which the current user has 'submit' privileges.
`int`	`countCollectionsWithSubmit(String q, Context context, Community community, String entityType)`	Counts the number of Collection for which the current user has 'submit' privileges.
`int`	`countTotal(Context context)`
`Collection`	`create(Context context, Community community)`	Create a new collection with a new ID.
`Collection`	`create(Context context, Community community, String handle)`	Create a new collection with the supplied handle and with a new ID.
`Collection`	`create(Context context, Community community, String handle, UUID uuid)`	Create a new collection with the supplied handle and ID.
`Group`	`createAdministrators(Context context, Collection collection)`	Create a default administrators group if one does not already exist.
`Group`	`createDefaultReadGroup(Context context, Collection collection, String typeOfGroupString, int defaultRead)`	This method will create a default read group for the given Collection.
`Group`	`createSubmitters(Context context, Collection collection)`	Create a default submitters group if one does not already exist.
`void`	`createTemplateItem(Context context, Collection collection)`	Create an empty template item for this collection.
`Group`	`createWorkflowGroup(Context context, Collection collection, int step)`	Create a workflow group for the given step if one does not already exist.
`void`	`delete(Context context, Collection collection)`
`Collection`	`find(Context context, UUID id)`	Generic find for when the precise type of an Entity is not known
`List<Collection>`	`findAll(Context context)`	Get all collections in the system.
`List<Collection>`	`findAll(Context context, Integer limit, Integer offset)`	Get all collections in the system.
`List<Collection>`	`findAuthorized(Context context, Community community, int actionID)`	return an array of collections that user has a given permission on (useful for trimming 'select to collection' list) or figuring out which collections a person is an editor for.
`List<Collection>`	`findAuthorizedOptimized(Context context, int actionID)`
`Collection`	`findByGroup(Context context, Group group)`
`Collection`	`findByIdOrLegacyId(Context context, String id)`
`Collection`	`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.
`List<Collection>`	`findCollectionsWithSubmit(String q, Context context, Community community, int offset, int limit)`	Returns Collections for which the current user has 'submit' privileges.
`List<Collection>`	`findCollectionsWithSubmit(String q, Context context, Community community, String entityType, int offset, int limit)`	Returns Collections for which the current user has 'submit' privileges.
`List<Collection>`	`findCollectionsWithSubscribers(Context context)`
`List<Collection>`	`findDirectMapped(Context context, int actionID)`
`List<Collection>`	`findGroup2CommunityMapped(Context context)`
`List<Collection>`	`findGroup2GroupMapped(Context context, int actionID)`
`List<Collection>`	`findGroupMapped(Context context, int actionID)`
`DSpaceObject`	`getAdminObject(Context context, Collection collection, int action)`	Return the dspace object where an ADMIN action right is sufficient to grant the initial authorize check.
`List<Map.Entry<Collection,Long>>`	`getCollectionsWithBitstreamSizesTotal(Context context)`	The map entry returned contains a collection as a key and sum of bitstream sizes in bytes as a value
`String`	`getDefaultReadGroupName(Collection collection, String typeOfGroupString)`	This method will return the name to give to the group created by the `CollectionService.createDefaultReadGroup(Context, Collection, String, int)` method
`String`	`getLicense(Collection collection)`	Get the license that users must grant before submitting to this collection.
`DSpaceObject`	`getParentObject(Context context, Collection collection)`	Return the dspace object that "own" the current object in the hierarchy.
`int`	`getSupportsTypeConstant()`	Returns the Constants which this service supports
`Group`	`getWorkflowGroup(Context context, Collection collection, int step)`	Get the the workflow group corresponding to a particular workflow step.
`boolean`	`hasCustomLicense(Collection collection)`	Find out if the collection has a custom license
`void`	`removeAdministrators(Context context, Collection collection)`	Remove the administrators group, if no group has already been created then return without error.
`void`	`removeItem(Context context, Collection collection, Item item)`	Remove an item.
`void`	`removeSubmitters(Context context, Collection collection)`	Remove the submitters group, if no group has already been created then return without error.
`void`	`removeTemplateItem(Context context, Collection collection)`	Remove the template item for this collection, if there is one.
`Bitstream`	`setLogo(Context context, Collection collection, InputStream is)`	Give the collection a logo.
`void`	`setMetadataSingleValue(Context context, Collection collection, MetadataFieldName field, String language, String value)`	Set first metadata field value
`void`	`setWorkflowGroup(Context context, Collection collection, int step, Group group)`	Set the workflow group corresponding to a particular workflow step.
`void`	`update(Context context, Collection collection)`
`void`	`updateLastModified(Context context, Collection collection)`

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
addAndShiftRightMetadata, addMetadata, addMetadata, addMetadata, addMetadata, addMetadata, addMetadata, addMetadata, addMetadata, addMetadata, clearMetadata, getIdentifiers, getMetadata, getMetadata, getMetadata, getMetadata, getMetadataByMetadataString, getMetadataFirstValue, getMetadataFirstValue, getName, getTypeText, moveMetadata, removeMetadataValues, replaceMetadata, setMetadataModified, setMetadataSingleValue

- Field Detail
  - collectionDAO
```
@Autowired(required=true)
protected CollectionDAO collectionDAO
```
  - authorizeService
```
@Autowired(required=true)
protected AuthorizeService authorizeService
```
  - resourcePolicyService
```
@Autowired(required=true)
protected ResourcePolicyService resourcePolicyService
```
  - bitstreamService
```
@Autowired(required=true)
protected BitstreamService bitstreamService
```
  - itemService
```
@Autowired(required=true)
protected ItemService itemService
```
  - communityService
```
@Autowired(required=true)
protected CommunityService communityService
```
  - groupService
```
@Autowired(required=true)
protected GroupService groupService
```
  - identifierService
```
@Autowired(required=true)
protected IdentifierService identifierService
```
  - licenseService
```
@Autowired(required=true)
protected LicenseService licenseService
```
  - subscribeService
```
@Autowired(required=true)
protected SubscribeService subscribeService
```
  - workspaceItemService
```
@Autowired(required=true)
protected WorkspaceItemService workspaceItemService
```
  - harvestedCollectionService
```
@Autowired(required=true)
protected HarvestedCollectionService harvestedCollectionService
```
  - workflowFactory
```
@Autowired(required=true)
protected XmlWorkflowFactory workflowFactory
```
  - collectionRoleService
```
@Autowired(required=true)
protected CollectionRoleService collectionRoleService
```
  - searchService
```
@Autowired(required=true)
protected SearchService searchService
```
  - configurationService
```
@Autowired(required=true)
protected ConfigurationService configurationService
```
- Constructor Detail
  - CollectionServiceImpl
```
protected CollectionServiceImpl()
```
- Method Detail
  - create
```
public Collection create(Context context,
                         Community community)
                  throws SQLException,
                         AuthorizeException
```
    Description copied from interface: CollectionService
    
    Create a new collection with a new ID. Once created the collection is added to the given community
    
    Specified by:
    
    create in interface CollectionService
    
    Parameters:
    
    context - DSpace context object
    
    community - DSpace Community (parent)
    
    Returns:
    
    the newly created collection
    
    Throws:
    
    SQLException - if database error
    
    AuthorizeException - if authorization error
  - create
```
public Collection create(Context context,
                         Community community,
                         String handle)
                  throws SQLException,
                         AuthorizeException
```
    Description copied from interface: CollectionService
    
    Create a new collection with the supplied handle and with a new ID. Once created the collection is added to the given community
    
    Specified by:
    
    create in interface CollectionService
    
    Parameters:
    
    context - DSpace context object
    
    community - DSpace Community (parent)
    
    handle - the pre-determined Handle to assign to the new community
    
    Returns:
    
    the newly created collection
    
    Throws:
    
    SQLException - if database error
    
    AuthorizeException - if authorization error
  - create
```
public Collection create(Context context,
                         Community community,
                         String handle,
                         UUID uuid)
                  throws SQLException,
                         AuthorizeException
```
    Description copied from interface: CollectionService
    
    Create a new collection with the supplied handle and ID. Once created the collection is added to the given community
    
    Specified by:
    
    create in interface CollectionService
    
    Parameters:
    
    context - DSpace context object
    
    community - DSpace Community (parent)
    
    handle - the pre-determined Handle to assign to the new collection
    
    uuid - the pre-determined UUID to assign to the new collection
    
    Returns:
    
    the newly created collection
    
    Throws:
    
    SQLException - if database error
    
    AuthorizeException - if authorization error
  - findAll
```
public List<Collection> findAll(Context context)
                         throws SQLException
```
    Description copied from interface: CollectionService
    
    Get all collections in the system. These are alphabetically sorted by collection name.
    
    Specified by:
    
    findAll in interface CollectionService
    
    Parameters:
    
    context - DSpace context object
    
    Returns:
    
    the collections in the system
    
    Throws:
    
    SQLException - if database error
  - findAll
```
public List<Collection> findAll(Context context,
                                Integer limit,
                                Integer offset)
                         throws SQLException
```
    Description copied from interface: CollectionService
    
    Get all collections in the system. Adds support for limit and offset.
    
    Specified by:
    
    findAll in interface CollectionService
    
    Parameters:
    
    context - The relevant DSpace Context.
    
    limit - paging limit
    
    offset - paging offset
    
    Returns:
    
    List of Collections
    
    Throws:
    
    SQLException - if database error
  - findAuthorizedOptimized
```
public List<Collection> findAuthorizedOptimized(Context context,
                                                int actionID)
                                         throws SQLException
```
    Specified by:
    
    findAuthorizedOptimized in interface CollectionService
    
    Throws:
    
    SQLException
  - findDirectMapped
```
public List<Collection> findDirectMapped(Context context,
                                         int actionID)
                                  throws SQLException
```
    Specified by:
    
    findDirectMapped in interface CollectionService
    
    Throws:
    
    SQLException
  - findGroup2CommunityMapped
```
public List<Collection> findGroup2CommunityMapped(Context context)
                                           throws SQLException
```
    Specified by:
    
    findGroup2CommunityMapped in interface CollectionService
    
    Throws:
    
    SQLException
  - findGroup2GroupMapped
```
public List<Collection> findGroup2GroupMapped(Context context,
                                              int actionID)
                                       throws SQLException
```
    Specified by:
    
    findGroup2GroupMapped in interface CollectionService
    
    Throws:
    
    SQLException
  - findGroupMapped
```
public List<Collection> findGroupMapped(Context context,
                                        int actionID)
                                 throws SQLException
```
    Specified by:
    
    findGroupMapped in interface CollectionService
    
    Throws:
    
    SQLException
  - find
```
public Collection find(Context context,
                       UUID id)
                throws SQLException
```
    Description copied from interface: DSpaceObjectService
    
    Generic find for when the precise type of an Entity is not known
    
    Specified by:
    
    find in interface DSpaceObjectService<Collection>
    
    Parameters:
    
    context - - the context
    
    id - - uuid within table of typed dspace objects
    
    Returns:
    
    the dspace object found, or null if it does not exist.
    
    Throws:
    
    SQLException - only upon failure accessing the database.
  - setMetadataSingleValue
```
public void setMetadataSingleValue(Context context,
                                   Collection collection,
                                   MetadataFieldName field,
                                   String language,
                                   String value)
                            throws MissingResourceException,
                                   SQLException
```
    Description copied from interface: DSpaceObjectService
    
    Set first metadata field value
    
    Specified by:
    
    setMetadataSingleValue in interface DSpaceObjectService<Collection>
    
    Overrides:
    
    setMetadataSingleValue in class DSpaceObjectServiceImpl<Collection>
    
    Parameters:
    
    context - DSpace context
    
    collection - DSpaceObject
    
    field - {schema, element, qualifier} for the desired field.
    
    language - the ISO639 language code, optionally followed by an underscore and the ISO3166 country code. null means only values with no language are removed, and Item.ANY means values with any country code or no country code are removed.
    
    value - metadata value
    
    Throws:
    
    SQLException - if database error
    
    MissingResourceException
  - setLogo
```
public Bitstream setLogo(Context context,
                         Collection collection,
                         InputStream is)
                  throws AuthorizeException,
                         IOException,
                         SQLException
```
    Description copied from interface: CollectionService
    
    Give the collection a logo. Passing in null removes any existing logo. You will need to set the format of the new logo bitstream before it will work, for example to "JPEG". Note that update will need to be called for the change to take effect. Setting a logo and not calling update later may result in a previous logo lying around as an "orphaned" bitstream.
    
    Specified by:
    
    setLogo in interface CollectionService
    
    Parameters:
    
    context - DSpace Context
    
    collection - Collection
    
    is - the stream to use as the new logo
    
    Returns:
    
    the new logo bitstream, or null if there is no logo (null was passed in)
    
    Throws:
    
    AuthorizeException - if authorization error
    
    IOException - if IO error
    
    SQLException - if database error
  - createWorkflowGroup
```
public Group createWorkflowGroup(Context context,
                                 Collection collection,
                                 int step)
                          throws SQLException,
                                 AuthorizeException
```
    Description copied from interface: CollectionService
    
    Create a workflow group for the given step if one does not already exist. Returns either the newly created group or the previously existing one. Note that while the new group is created in the database, the association between the group and the collection is not written until update is called.
    
    Specified by:
    
    createWorkflowGroup in interface CollectionService
    
    Parameters:
    
    context - DSpace Context
    
    collection - Collection
    
    step - the step (1-3) of the workflow to create or get the group for
    
    Returns:
    
    the workflow group associated with this collection
    
    Throws:
    
    SQLException - if database error
    
    AuthorizeException - if authorization error
  - setWorkflowGroup
```
public void setWorkflowGroup(Context context,
                             Collection collection,
                             int step,
                             Group group)
                      throws SQLException
```
    Description copied from interface: CollectionService
    
    Set the workflow group corresponding to a particular workflow step. null can be passed in if there should be no associated group for that workflow step; any existing group is NOT deleted.
    
    Specified by:
    
    setWorkflowGroup in interface CollectionService
    
    Parameters:
    
    context - current DSpace session.
    
    collection - Collection
    
    step - the workflow step (1-3)
    
    group - the new workflow group, or null
    
    Throws:
    
    SQLException - passed through.
  - getWorkflowGroup
```
public Group getWorkflowGroup(Context context,
                              Collection collection,
                              int step)
```
    Description copied from interface: CollectionService
    
    Get the the workflow group corresponding to a particular workflow step. This returns null if there is no group associated with this collection for the given step.
    
    Specified by:
    
    getWorkflowGroup in interface CollectionService
    
    Parameters:
    
    context - DSpace Context
    
    collection - Collection
    
    step - the workflow step (1-3)
    
    Returns:
    
    the group of reviewers or null
  - createSubmitters
```
public Group createSubmitters(Context context,
                              Collection collection)
                       throws SQLException,
                              AuthorizeException
```
    Description copied from interface: CollectionService
    
    Create a default submitters group if one does not already exist. Returns either the newly created group or the previously existing one. Note that other groups may also be allowed to submit to this collection by the authorization system.
    
    Specified by:
    
    createSubmitters in interface CollectionService
    
    Parameters:
    
    context - DSpace Context
    
    collection - Collection
    
    Returns:
    
    the default group of submitters associated with this collection
    
    Throws:
    
    SQLException - if database error
    
    AuthorizeException - if authorization error
  - removeSubmitters
```
public void removeSubmitters(Context context,
                             Collection collection)
                      throws SQLException,
                             AuthorizeException
```
    Description copied from interface: CollectionService
    
    Remove the submitters group, if no group has already been created then return without error. This will merely dereference the current submitters group from the collection so that it may be deleted without violating database constraints.
    
    Specified by:
    
    removeSubmitters in interface CollectionService
    
    Parameters:
    
    context - DSpace Context
    
    collection - Collection
    
    Throws:
    
    SQLException - if database error
    
    AuthorizeException - if authorization error
  - createAdministrators
```
public Group createAdministrators(Context context,
                                  Collection collection)
                           throws SQLException,
                                  AuthorizeException
```
    Description copied from interface: CollectionService
    
    Create a default administrators group if one does not already exist. Returns either the newly created group or the previously existing one. Note that other groups may also be administrators.
    
    Specified by:
    
    createAdministrators in interface CollectionService
    
    Parameters:
    
    context - DSpace Context
    
    collection - Collection
    
    Returns:
    
    the default group of editors associated with this collection
    
    Throws:
    
    SQLException - if database error
    
    AuthorizeException - if authorization error
  - removeAdministrators
```
public void removeAdministrators(Context context,
                                 Collection collection)
                          throws SQLException,
                                 AuthorizeException
```
    Description copied from interface: CollectionService
    
    Remove the administrators group, if no group has already been created then return without error. This will merely dereference the current administrators group from the collection so that it may be deleted without violating database constraints.
    
    Specified by:
    
    removeAdministrators in interface CollectionService
    
    Parameters:
    
    context - DSpace Context
    
    collection - Collection
    
    Throws:
    
    SQLException - if database error
    
    AuthorizeException - if authorization error
  - getLicense
```
public String getLicense(Collection collection)
```
    Description copied from interface: CollectionService
    
    Get the license that users must grant before submitting to this collection. If the collection does not have a specific license, the site-wide default is returned.
    
    Specified by:
    
    getLicense in interface CollectionService
    
    Parameters:
    
    collection - Collection
    
    Returns:
    
    the license for this collection
  - hasCustomLicense
```
public boolean hasCustomLicense(Collection collection)
```
    Description copied from interface: CollectionService
    
    Find out if the collection has a custom license
    
    Specified by:
    
    hasCustomLicense in interface CollectionService
    
    Parameters:
    
    collection - Collection
    
    Returns:
    
    true if the collection has a custom license
  - createTemplateItem
```
public void createTemplateItem(Context context,
                               Collection collection)
                        throws SQLException,
                               AuthorizeException
```
    Description copied from interface: CollectionService
    
    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 CollectionService
    
    Parameters:
    
    context - DSpace Context
    
    collection - Collection
    
    Throws:
    
    SQLException - if database error
    
    AuthorizeException - if authorization error
  - removeTemplateItem
```
public void removeTemplateItem(Context context,
                               Collection collection)
                        throws SQLException,
                               AuthorizeException,
                               IOException
```
    Description copied from interface: CollectionService
    
    Remove the template item for this collection, if there is one. Note that since this has to remove the old template item ID from the collection record in the database, the collection record will be changed, including any other changes made; in other words, this method does an update.
    
    Specified by:
    
    removeTemplateItem in interface CollectionService
    
    Parameters:
    
    context - DSpace Context
    
    collection - Collection
    
    Throws:
    
    SQLException - if database error
    
    AuthorizeException - if authorization error
    
    IOException - if IO error
  - addItem
```
public void addItem(Context context,
                    Collection collection,
                    Item item)
             throws SQLException,
                    AuthorizeException
```
    Description copied from interface: CollectionService
    
    Add an item to the collection. This simply adds a relationship between the item and the collection - it does nothing like set an issue date, remove a personal workspace item etc. This has instant effect; update need not be called.
    
    Specified by:
    
    addItem in interface CollectionService
    
    Parameters:
    
    context - DSpace Context
    
    collection - Collection
    
    item - item to add
    
    Throws:
    
    SQLException - if database error
    
    AuthorizeException - if authorization error
  - removeItem
```
public void removeItem(Context context,
                       Collection collection,
                       Item item)
                throws SQLException,
                       AuthorizeException,
                       IOException
```
    Description copied from interface: CollectionService
    
    Remove an item. If the item is then orphaned, it is deleted.
    
    Specified by:
    
    removeItem in interface CollectionService
    
    Parameters:
    
    context - DSpace Context
    
    collection - Collection
    
    item - item to remove
    
    Throws:
    
    SQLException - if database error
    
    AuthorizeException - if authorization error
    
    IOException - if IO error
  - update
```
public void update(Context context,
                   Collection collection)
            throws SQLException,
                   AuthorizeException
```
    Specified by:
    
    update in interface DSpaceObjectService<Collection>
    
    Overrides:
    
    update in class DSpaceObjectServiceImpl<Collection>
    
    Throws:
    
    SQLException
    
    AuthorizeException
  - canEditBoolean
```
public boolean canEditBoolean(Context context,
                              Collection collection)
                       throws SQLException
```
    Specified by:
    
    canEditBoolean in interface CollectionService
    
    Throws:
    
    SQLException
  - canEditBoolean
```
public boolean canEditBoolean(Context context,
                              Collection collection,
                              boolean useInheritance)
                       throws SQLException
```
    Specified by:
    
    canEditBoolean in interface CollectionService
    
    Throws:
    
    SQLException
  - canEdit
```
public void canEdit(Context context,
                    Collection collection)
             throws SQLException,
                    AuthorizeException
```
    Specified by:
    
    canEdit in interface CollectionService
    
    Throws:
    
    SQLException
    
    AuthorizeException
  - canEdit
```
public void canEdit(Context context,
                    Collection collection,
                    boolean useInheritance)
             throws SQLException,
                    AuthorizeException
```
    Specified by:
    
    canEdit in interface CollectionService
    
    Throws:
    
    SQLException
    
    AuthorizeException
  - delete
```
public void delete(Context context,
                   Collection collection)
            throws SQLException,
                   AuthorizeException,
                   IOException
```
    Specified by:
    
    delete in interface DSpaceObjectService<Collection>
    
    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<Collection>
    
    Specified by:
    
    getSupportsTypeConstant in interface DSpaceObjectService<Collection>
    
    Returns:
    
    a org.dspace.core.Constants that represents a IndexableObject type
  - findAuthorized
```
public List<Collection> findAuthorized(Context context,
                                       Community community,
                                       int actionID)
                                throws SQLException
```
    Description copied from interface: CollectionService
    
    return an array of collections that user has a given permission on (useful for trimming 'select to collection' list) or figuring out which collections a person is an editor for.
    
    Specified by:
    
    findAuthorized in interface CollectionService
    
    Parameters:
    
    context - DSpace Context
    
    community - (optional) restrict search to a community, else null
    
    actionID - of the action
    
    Returns:
    
    Collection [] of collections with matching permissions
    
    Throws:
    
    SQLException - if database error
  - findByGroup
```
public Collection findByGroup(Context context,
                              Group group)
                       throws SQLException
```
    Specified by:
    
    findByGroup in interface CollectionService
    
    Parameters:
    
    context - DSpace Context
    
    group - EPerson Group
    
    Returns:
    
    the collection, if any, that has the specified group as administrators or submitters
    
    Throws:
    
    SQLException
  - findCollectionsWithSubscribers
```
public List<Collection> findCollectionsWithSubscribers(Context context)
                                                throws SQLException
```
    Specified by:
    
    findCollectionsWithSubscribers in interface CollectionService
    
    Throws:
    
    SQLException
  - getAdminObject
```
public DSpaceObject getAdminObject(Context context,
                                   Collection collection,
                                   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<Collection>
    
    Overrides:
    
    getAdminObject in class DSpaceObjectServiceImpl<Collection>
    
    Parameters:
    
    context - DSpace context
    
    collection - 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,
                                    Collection collection)
                             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<Collection>
    
    Overrides:
    
    getParentObject in class DSpaceObjectServiceImpl<Collection>
    
    Parameters:
    
    context - DSpace context
    
    collection - DSpaceObject
    
    Returns:
    
    the dspace object that "own" the current object in the hierarchy
    
    Throws:
    
    SQLException - if database error
  - updateLastModified
```
public void updateLastModified(Context context,
                               Collection collection)
                        throws SQLException,
                               AuthorizeException
```
    Specified by:
    
    updateLastModified in interface DSpaceObjectService<Collection>
    
    Throws:
    
    SQLException
    
    AuthorizeException
  - findByIdOrLegacyId
```
public Collection findByIdOrLegacyId(Context context,
                                     String id)
                              throws SQLException
```
    Specified by:
    
    findByIdOrLegacyId in interface DSpaceObjectLegacySupportService<Collection>
    
    Throws:
    
    SQLException
  - findByLegacyId
```
public Collection 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<Collection>
    
    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.
  - countTotal
```
public int countTotal(Context context)
               throws SQLException
```
    Specified by:
    
    countTotal in interface CollectionService
    
    Throws:
    
    SQLException
  - getCollectionsWithBitstreamSizesTotal
```
public List<Map.Entry<Collection,Long>> getCollectionsWithBitstreamSizesTotal(Context context)
                                                                             throws SQLException
```
    Description copied from interface: CollectionService
    
    The map entry returned contains a collection as a key and sum of bitstream sizes in bytes as a value
    
    Specified by:
    
    getCollectionsWithBitstreamSizesTotal in interface CollectionService
    
    Parameters:
    
    context - DSpace Context
    
    Returns:
    
    List of Collections and bitstream sizes map
    
    Throws:
    
    SQLException - if database error
  - createDefaultReadGroup
```
public Group createDefaultReadGroup(Context context,
                                    Collection collection,
                                    String typeOfGroupString,
                                    int defaultRead)
                             throws SQLException,
                                    AuthorizeException
```
    Description copied from interface: CollectionService
    
    This method will create a default read group for the given Collection. It'll create either a defaultItemRead or a defaultBitstreamRead group depending on the given parameters
    
    Specified by:
    
    createDefaultReadGroup in interface CollectionService
    
    Parameters:
    
    context - The relevant DSpace context
    
    collection - The collection for which it'll be created
    
    typeOfGroupString - The type of group to be made, item or bitstream
    
    defaultRead - The defaultRead int, item or bitstream
    
    Returns:
    
    The created Group
    
    Throws:
    
    SQLException - If something goes wrong
    
    AuthorizeException - If something goes wrong
  - getDefaultReadGroupName
```
public String getDefaultReadGroupName(Collection collection,
                                      String typeOfGroupString)
```
    Description copied from interface: CollectionService
    
    This method will return the name to give to the group created by the CollectionService.createDefaultReadGroup(Context, Collection, String, int) method
    
    Specified by:
    
    getDefaultReadGroupName in interface CollectionService
    
    Parameters:
    
    collection - The DSpace collection to use in the name generation
    
    typeOfGroupString - The type of group to use in the name generation
    
    Returns:
    
    the name to give to the group that hold default read for the collection
  - findCollectionsWithSubmit
```
public List<Collection> findCollectionsWithSubmit(String q,
                                                  Context context,
                                                  Community community,
                                                  int offset,
                                                  int limit)
                                           throws SQLException,
                                                  SearchServiceException
```
    Description copied from interface: CollectionService
    
    Returns Collections for which the current user has 'submit' privileges. NOTE: for better performance, this method retrieves its results from an index (cache) and does not query the database directly. This means that results may be stale or outdated until https://github.com/DSpace/DSpace/issues/2853 is resolved"
    
    Specified by:
    
    findCollectionsWithSubmit in interface CollectionService
    
    Parameters:
    
    q - limit the returned collection to those with metadata values matching the query terms. The terms are used to make also a prefix query on SOLR so it can be used to implement an autosuggest feature over the collection name
    
    context - DSpace Context
    
    community - parent community
    
    offset - the position of the first result to return
    
    limit - paging limit
    
    Returns:
    
    discovery search result objects
    
    Throws:
    
    SQLException - if something goes wrong
    
    SearchServiceException - if search error
  - countCollectionsWithSubmit
```
public int countCollectionsWithSubmit(String q,
                                      Context context,
                                      Community community)
                               throws SQLException,
                                      SearchServiceException
```
    Description copied from interface: CollectionService
    
    Counts the number of Collection for which the current user has 'submit' privileges. NOTE: for better performance, this method retrieves its results from an index (cache) and does not query the database directly. This means that results may be stale or outdated until https://github.com/DSpace/DSpace/issues/2853 is resolved."
    
    Specified by:
    
    countCollectionsWithSubmit in interface CollectionService
    
    Parameters:
    
    q - limit the returned collection to those with metadata values matching the query terms. The terms are used to make also a prefix query on SOLR so it can be used to implement an autosuggest feature over the collection name
    
    context - DSpace Context
    
    community - parent community
    
    Returns:
    
    total collections found
    
    Throws:
    
    SQLException - if something goes wrong
    
    SearchServiceException - if search error
  - findCollectionsWithSubmit
```
public List<Collection> findCollectionsWithSubmit(String q,
                                                  Context context,
                                                  Community community,
                                                  String entityType,
                                                  int offset,
                                                  int limit)
                                           throws SQLException,
                                                  SearchServiceException
```
    Description copied from interface: CollectionService
    
    Returns Collections for which the current user has 'submit' privileges. NOTE: for better performance, this method retrieves its results from an index (cache) and does not query the database directly. This means that results may be stale or outdated until https://github.com/DSpace/DSpace/issues/2853 is resolved"
    
    Specified by:
    
    findCollectionsWithSubmit in interface CollectionService
    
    Parameters:
    
    q - limit the returned collection to those with metadata values matching the query terms. The terms are used to make also a prefix query on SOLR so it can be used to implement an autosuggest feature over the collection name
    
    context - DSpace Context
    
    community - parent community
    
    entityType - limit the returned collection to those related to given entity type
    
    offset - the position of the first result to return
    
    limit - paging limit
    
    Returns:
    
    discovery search result objects
    
    Throws:
    
    SQLException - if something goes wrong
    
    SearchServiceException - if search error
  - countCollectionsWithSubmit
```
public int countCollectionsWithSubmit(String q,
                                      Context context,
                                      Community community,
                                      String entityType)
                               throws SQLException,
                                      SearchServiceException
```
    Description copied from interface: CollectionService
    
    Counts the number of Collection for which the current user has 'submit' privileges. NOTE: for better performance, this method retrieves its results from an index (cache) and does not query the database directly. This means that results may be stale or outdated until https://github.com/DSpace/DSpace/issues/2853 is resolved."
    
    Specified by:
    
    countCollectionsWithSubmit in interface CollectionService
    
    Parameters:
    
    q - limit the returned collection to those with metadata values matching the query terms. The terms are used to make also a prefix query on SOLR so it can be used to implement an autosuggest feature over the collection name
    
    context - DSpace Context
    
    community - parent community
    
    entityType - limit the returned collection to those related to given entity type
    
    Returns:
    
    total collections found
    
    Throws:
    
    SQLException - if something goes wrong
    
    SearchServiceException - if search error

Class CollectionServiceImpl

Field Summary

Fields inherited from class org.dspace.content.DSpaceObjectServiceImpl

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

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

collectionDAO

authorizeService

resourcePolicyService

bitstreamService

itemService

communityService

groupService

identifierService

licenseService

subscribeService

workspaceItemService

harvestedCollectionService

workflowFactory

collectionRoleService

searchService

configurationService

Constructor Detail

CollectionServiceImpl

Method Detail

create

create

create

findAll

findAll

findAuthorizedOptimized

findDirectMapped

findGroup2CommunityMapped

findGroup2GroupMapped

findGroupMapped

find

setMetadataSingleValue

setLogo

createWorkflowGroup

setWorkflowGroup

getWorkflowGroup

createSubmitters

removeSubmitters

createAdministrators

removeAdministrators

getLicense

hasCustomLicense

createTemplateItem

removeTemplateItem

addItem

removeItem

update

canEditBoolean

canEditBoolean

canEdit

canEdit

delete

getSupportsTypeConstant

findAuthorized

findByGroup

findCollectionsWithSubscribers

getAdminObject

getParentObject

updateLastModified

findByIdOrLegacyId

findByLegacyId

countTotal

getCollectionsWithBitstreamSizesTotal

createDefaultReadGroup

getDefaultReadGroupName

findCollectionsWithSubmit

countCollectionsWithSubmit

findCollectionsWithSubmit

countCollectionsWithSubmit