Collection (DSpace Kernel :: API and Implementation 4.1 API)

java.lang.Object
- org.dspace.content.DSpaceObject
- - org.dspace.content.Collection

```
public class Collection
extends DSpaceObject
```
Class representing a collection.
The collection's metadata (name, introductory text etc), workflow groups, and default group of submitters are loaded into memory. Changes to metadata are not written to the database until update is called. If you create or remove a workflow group, the change is only reflected in the database after calling update. The default group of submitters is slightly different - creating or removing this has instant effect.

Version:

$Revision$

Author:

Robert Tansley

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`COPYRIGHT_TEXT`
`static String`	`INTRODUCTORY_TEXT`
`static String`	`PROVENANCE_TEXT`
`static String`	`SHORT_DESCRIPTION`
`static String`	`SIDEBAR_TEXT`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`addItem(Item item)` Add an item to the collection.
`void`	`canEdit()`
`void`	`canEdit(boolean useInheritance)`
`boolean`	`canEditBoolean()`
`boolean`	`canEditBoolean(boolean useInheritance)`
`int`	`countItems()` counts items in this collection
`Group`	`createAdministrators()` Create a default administrators group if one does not already exist.
`Group`	`createSubmitters()` Create a default submitters group if one does not already exist.
`void`	`createTemplateItem()` Create an empty template item for this collection.
`Group`	`createWorkflowGroup(int step)` Create a workflow group for the given step if one does not already exist.
`boolean`	`equals(Object other)` Return `true` if `other` is the same Collection as this object, `false` otherwise
`static Collection`	`find(Context context, int id)` Get a collection from the database.
`static Collection[]`	`findAll(Context context)` Get all collections in the system.
`static Collection[]`	`findAll(Context context, Integer limit, Integer offset)` Get all collections in the system.
`static Collection[]`	`findAuthorized(Context context, Community comm, 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.
`Group`	`getAdministrators()` Get the default group of administrators, if there is one.
`DSpaceObject`	`getAdminObject(int action)` Return the dspace object where an ADMIN action right is sufficient to grant the initial authorize check.
`ItemIterator`	`getAllItems()` Get all the items in this collection.
`Community[]`	`getCommunities()` Get the communities this collection appears in
`String`	`getHandle()` Get the Handle of the object.
`int`	`getID()` Get the internal ID of this collection
`ItemIterator`	`getItems()` Get the in_archive items in this collection.
`ItemIterator`	`getItems(Integer limit, Integer offset)` Get the in_archive items in this collection.
`String`	`getLicense()` Get the license that users must grant before submitting to this collection.
`String`	`getLicenseCollection()` Get the license that users must grant before submitting to this collection.
`Bitstream`	`getLogo()` Get the logo for the collection.
`String`	`getMetadata(String field)` Get the value of a metadata field
`String`	`getName()` Get a proper name for the object.
`DSpaceObject`	`getParentObject()` Return the dspace object that "own" the current object in the hierarchy.
`Group`	`getSubmitters()` Get the default group of submitters, if there is one.
`Item`	`getTemplateItem()` Get the template item for this collection.
`int`	`getType()` return type found in Constants
`Group`	`getWorkflowGroup(int step)` Get the the workflow group corresponding to a particular workflow step.
`boolean`	`hasCustomLicense()` Find out if the collection has a custom license
`int`	`hashCode()`
`void`	`removeAdministrators()` Remove the administrators group, if no group has already been created then return without error.
`void`	`removeItem(Item item)` Remove an item.
`void`	`removeSubmitters()` Remove the submitters group, if no group has already been created then return without error.
`void`	`removeTemplateItem()` Remove the template item for this collection, if there is one.
`void`	`setLicense(String license)` Set the license for this collection.
`Bitstream`	`setLogo(InputStream is)` Give the collection a logo.
`void`	`setMetadata(String field, String value)` Set a metadata value
`void`	`setWorkflowGroup(int step, Group g)` Set the workflow group corresponding to a particular workflow step.
`void`	`update()` Update the collection metadata (including logo and workflow groups) to the database.
`void`	`updateLastModified()`

Methods inherited from class org.dspace.content.DSpaceObject
addDetails, clearDetails, find, getDetails, getTypeText

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

- Field Detail
  - COPYRIGHT_TEXT
```
public static final String COPYRIGHT_TEXT
```
    See Also:
    Constant Field Values
  - INTRODUCTORY_TEXT
```
public static final String INTRODUCTORY_TEXT
```
    See Also:
    Constant Field Values
  - SHORT_DESCRIPTION
```
public static final String SHORT_DESCRIPTION
```
    See Also:
    Constant Field Values
  - SIDEBAR_TEXT
```
public static final String SIDEBAR_TEXT
```
    See Also:
    Constant Field Values
  - PROVENANCE_TEXT
```
public static final String PROVENANCE_TEXT
```
    See Also:
    Constant Field Values
- Method Detail
  - find
```
public static Collection find(Context context,
              int id)
                       throws SQLException
```
    Get a collection from the database. Loads in the metadata
    
    Parameters:
    context - DSpace context object
    id - ID of the collection
    
    Returns:
    the collection, or null if the ID is invalid.
    
    Throws:
    
    SQLException
  - findAll
```
public static Collection[] findAll(Context context)
                            throws SQLException
```
    Get all collections in the system. These are alphabetically sorted by collection name.
    
    Parameters:
    context - DSpace context object
    
    Returns:
    the collections in the system
    
    Throws:
    
    SQLException
  - findAll
```
public static Collection[] findAll(Context context,
                   Integer limit,
                   Integer offset)
                            throws SQLException
```
    Get all collections in the system. Adds support for limit and offset.
    
    Parameters:
    context -
    limit -
    offset -
    
    Returns:
    
    Throws:
    
    SQLException
  - getItems
```
public ItemIterator getItems()
                      throws SQLException
```
    Get the in_archive items in this collection. The order is indeterminate.
    
    Returns:
    an iterator over the items in the collection.
    
    Throws:
    
    SQLException
  - getItems
```
public ItemIterator getItems(Integer limit,
                    Integer offset)
                      throws SQLException
```
    Get the in_archive items in this collection. The order is indeterminate. Provides the ability to use limit and offset, for efficient paging.
    
    Parameters:
    limit - Max number of results in set
    offset - Number of results to jump ahead by. 100 = 100th result is first, not 100th page.
    
    Returns:
    an iterator over the items in the collection.
    
    Throws:
    
    SQLException
  - getAllItems
```
public ItemIterator getAllItems()
                         throws SQLException
```
    Get all the items in this collection. The order is indeterminate.
    
    Returns:
    an iterator over the items in the collection.
    
    Throws:
    
    SQLException
  - getID
```
public int getID()
```
    Get the internal ID of this collection
    
    Specified by:
    
    getID in class DSpaceObject
    
    Returns:
    the internal identifier
  - getHandle
```
public String getHandle()
```
    Description copied from class: DSpaceObject
    
    Get the Handle of the object. This may return null
    
    Specified by:
    
    getHandle in class DSpaceObject
    
    Returns:
    Handle of the object, or null if it doesn't have one
    See Also:
    DSpaceObject.getHandle()
  - getMetadata
```
public String getMetadata(String field)
```
    Get the value of a metadata field
    
    Parameters:
    field - the name of the metadata field to get
    
    Returns:
    the value of the metadata field
    
    Throws:
    
    IllegalArgumentException - if the requested metadata field doesn't exist
  - setMetadata
```
public void setMetadata(String field,
               String value)
                 throws MissingResourceException
```
    Set a metadata value
    
    Parameters:
    field - the name of the metadata field to get
    value - value to set the field to
    
    Throws:
    
    IllegalArgumentException - if the requested metadata field doesn't exist
    
    MissingResourceException
  - getName
```
public String getName()
```
    Description copied from class: DSpaceObject
    
    Get a proper name for the object. This may return null. Name should be suitable for display in a user interface.
    
    Specified by:
    
    getName in class DSpaceObject
    
    Returns:
    Name for the object, or null if it doesn't have one
  - getLogo
```
public Bitstream getLogo()
```
    Get the logo for the collection. null is returned if the collection does not have a logo.
    
    Returns:
    the logo of the collection, or null
  - setLogo
```
public Bitstream setLogo(InputStream is)
                  throws AuthorizeException,
                         IOException,
                         SQLException
```
    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.
    
    Parameters:
    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
    
    IOException
    
    SQLException
  - createWorkflowGroup
```
public Group createWorkflowGroup(int step)
                          throws SQLException,
                                 AuthorizeException
```
    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.
    
    Parameters:
    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
    
    AuthorizeException
  - setWorkflowGroup
```
public void setWorkflowGroup(int step,
                    Group g)
```
    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.
    
    Parameters:
    step - the workflow step (1-3)
    g - the new workflow group, or null
  - getWorkflowGroup
```
public Group getWorkflowGroup(int step)
```
    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.
    
    Parameters:
    step - the workflow step (1-3)
    
    Returns:
    the group of reviewers or null
  - createSubmitters
```
public Group createSubmitters()
                       throws SQLException,
                              AuthorizeException
```
    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.
    
    Returns:
    the default group of submitters associated with this collection
    
    Throws:
    
    SQLException
    
    AuthorizeException
  - removeSubmitters
```
public void removeSubmitters()
                      throws SQLException,
                             AuthorizeException
```
    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.
    
    Throws:
    
    SQLException
    
    AuthorizeException
  - getSubmitters
```
public Group getSubmitters()
```
    Get the default group of submitters, if there is one. Note that the authorization system may allow others to submit to the collection, so this is not necessarily a definitive list of potential submitters.
    The default group of submitters for collection 100 is the one called collection_100_submit.
    
    Returns:
    the default group of submitters, or null if there is no default group.
  - createAdministrators
```
public Group createAdministrators()
                           throws SQLException,
                                  AuthorizeException
```
    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.
    
    Returns:
    the default group of editors associated with this collection
    
    Throws:
    
    SQLException
    
    AuthorizeException
  - removeAdministrators
```
public void removeAdministrators()
                          throws SQLException,
                                 AuthorizeException
```
    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.
    
    Throws:
    
    SQLException
    
    AuthorizeException
  - getAdministrators
```
public Group getAdministrators()
```
    Get the default group of administrators, if there is one. Note that the authorization system may allow others to be administrators for the collection.
    The default group of administrators for collection 100 is the one called collection_100_admin.
    
    Returns:
    group of administrators, or null if there is no default group.
  - getLicense
```
public String getLicense()
```
    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.
    
    Returns:
    the license for this collection
  - getLicenseCollection
```
public String getLicenseCollection()
```
    Get the license that users must grant before submitting to this collection.
    
    Returns:
    the license for this collection
  - hasCustomLicense
```
public boolean hasCustomLicense()
```
    Find out if the collection has a custom license
    
    Returns:
    true if the collection has a custom license
  - setLicense
```
public void setLicense(String license)
```
    Set the license for this collection. Passing in null means that the site-wide default will be used.
    
    Parameters:
    license - the license, or null
  - getTemplateItem
```
public Item getTemplateItem()
                     throws SQLException
```
    Get the template item for this collection. null is returned if the collection does not have a template. Submission mechanisms may copy this template to provide a convenient starting point for a submission.
    
    Returns:
    the item template, or null
    
    Throws:
    
    SQLException
  - createTemplateItem
```
public void createTemplateItem()
                        throws SQLException,
                               AuthorizeException
```
    Create an empty template item for this collection. If one already exists, no action is taken. Caution: Make sure you call update on the collection after doing this, or the item will have been created but the collection record will not refer to it.
    
    Throws:
    
    SQLException
    
    AuthorizeException
  - removeTemplateItem
```
public void removeTemplateItem()
                        throws SQLException,
                               AuthorizeException,
                               IOException
```
    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.
    
    Throws:
    
    SQLException
    
    AuthorizeException
    
    IOException
  - addItem
```
public void addItem(Item item)
             throws SQLException,
                    AuthorizeException
```
    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.
    
    Parameters:
    item - item to add
    
    Throws:
    
    SQLException
    
    AuthorizeException
  - removeItem
```
public void removeItem(Item item)
                throws SQLException,
                       AuthorizeException,
                       IOException
```
    Remove an item. If the item is then orphaned, it is deleted.
    
    Parameters:
    item - item to remove
    
    Throws:
    
    SQLException
    
    AuthorizeException
    
    IOException
  - update
```
public void update()
            throws SQLException,
                   AuthorizeException
```
    Update the collection metadata (including logo and workflow groups) to the database. Inserts if this is a new collection.
    
    Specified by:
    
    update in class DSpaceObject
    
    Throws:
    
    SQLException
    
    IOException
    
    AuthorizeException
  - canEditBoolean
```
public boolean canEditBoolean()
                       throws SQLException
```
    Throws:
    
    SQLException
  - canEditBoolean
```
public boolean canEditBoolean(boolean useInheritance)
                       throws SQLException
```
    Throws:
    
    SQLException
  - canEdit
```
public void canEdit()
             throws AuthorizeException,
                    SQLException
```
    Throws:
    
    AuthorizeException
    
    SQLException
  - canEdit
```
public void canEdit(boolean useInheritance)
             throws AuthorizeException,
                    SQLException
```
    Throws:
    
    AuthorizeException
    
    SQLException
  - getCommunities
```
public Community[] getCommunities()
                           throws SQLException
```
    Get the communities this collection appears in
    
    Returns:
    array of Community objects
    
    Throws:
    
    SQLException
  - equals
```
public boolean equals(Object other)
```
    Return true if other is the same Collection as this object, false otherwise
    
    Overrides:
    
    equals in class Object
    
    Parameters:
    other - object to compare to
    
    Returns:
    true if object passed in represents the same collection as this object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - getType
```
public int getType()
```
    return type found in Constants
    
    Specified by:
    
    getType in class DSpaceObject
    
    Returns:
    int Constants.COLLECTION
  - findAuthorized
```
public static Collection[] findAuthorized(Context context,
                          Community comm,
                          int actionID)
                                   throws SQLException
```
    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.
    
    Parameters:
    context -
    comm - (optional) restrict search to a community, else null
    actionID - of the action
    
    Returns:
    Collection [] of collections with matching permissions
    
    Throws:
    
    SQLException
  - countItems
```
public int countItems()
               throws SQLException
```
    counts items in this collection
    
    Returns:
    total items
    
    Throws:
    
    SQLException
  - getAdminObject
```
public DSpaceObject getAdminObject(int action)
                            throws SQLException
```
    Description copied from class: DSpaceObject
    
    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.
    
    Overrides:
    
    getAdminObject in class DSpaceObject
    
    Parameters:
    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
  - getParentObject
```
public DSpaceObject getParentObject()
                             throws SQLException
```
    Description copied from class: DSpaceObject
    
    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.
    
    Overrides:
    
    getParentObject in class DSpaceObject
    
    Returns:
    the dspace object that "own" the current object in the hierarchy
    
    Throws:
    
    SQLException
  - updateLastModified
```
public void updateLastModified()
```
    Specified by:
    
    updateLastModified in class DSpaceObject

Class Collection

Field Summary

Method Summary

Methods inherited from class org.dspace.content.DSpaceObject

Methods inherited from class java.lang.Object

Field Detail

COPYRIGHT_TEXT

INTRODUCTORY_TEXT

SHORT_DESCRIPTION

SIDEBAR_TEXT

PROVENANCE_TEXT

Method Detail

find

findAll

findAll

getItems

getItems

getAllItems

getID

getHandle

getMetadata

setMetadata

getName

getLogo

setLogo

createWorkflowGroup

setWorkflowGroup

getWorkflowGroup

createSubmitters

removeSubmitters

getSubmitters

createAdministrators

removeAdministrators

getAdministrators

getLicense

getLicenseCollection

hasCustomLicense

setLicense

getTemplateItem

createTemplateItem

removeTemplateItem

addItem

removeItem

update

canEditBoolean

canEditBoolean

canEdit

canEdit

getCommunities

equals

hashCode

getType

findAuthorized

countItems

getAdminObject

getParentObject

updateLastModified