Community (DSpace Kernel :: API and Implementation 5.0-rc1 API)

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

```
public class Community
extends DSpaceObject
```
Class representing a community
The community's metadata (name, introductory text etc.) is loaded into' memory. Changes to this metadata are only reflected in the database after update is called.

Version:

$Revision$

Author:

Robert Tansley

Field Summary

Fields
Modifier and Type Field and Description

static String COPYRIGHT_TEXT

static String INTRODUCTORY_TEXT

static String SHORT_DESCRIPTION

static String SIDEBAR_TEXT
- Fields inherited from class org.dspace.content.DSpaceObject
  allMetadataFields, metadataCache, modifiedMetadata, ourContext

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

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`addCollection(Collection c)` Add an exisiting collection to the community
`void`	`addSubcommunity(Community c)` Add an exisiting community as a subcommunity to the community
`void`	`canEdit()`
`boolean`	`canEditBoolean()` return TRUE if context's user can edit community, false otherwise
`int`	`countItems()` counts items in this community
`static Community`	`create(Community parent, Context context)` Create a new top-level community, with a new ID.
`static Community`	`create(Community parent, Context context, String handle)` Create a new top-level community, with a new ID.
`Group`	`createAdministrators()` Create a default administrators group if one does not already exist.
`Collection`	`createCollection()` Create a new collection within this community.
`Collection`	`createCollection(String handle)` Create a new collection within this community.
`Community`	`createSubcommunity()` Create a new sub-community within this community.
`Community`	`createSubcommunity(String handle)` Create a new sub-community within this community.
`void`	`delete()` Delete the community, including the metadata and logo.
`boolean`	`equals(Object other)` Return `true` if `other` is the same Community as this object, `false` otherwise
`static Community`	`find(Context context, int id)` Get a community from the database.
`static Community[]`	`findAll(Context context)` Get a list of all communities in the system.
`static Community[]`	`findAllTop(Context context)` Get a list of all top-level communities in the system.
`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.
`Collection[]`	`getAllCollections()` Return an array of collections of this community and its subcommunities
`Community[]`	`getAllParents()` Return an array of parent communities of this community, in ascending order.
`Collection[]`	`getCollections()` Get the collections in this community.
`String`	`getHandle()` Get the Handle of the object.
`int`	`getID()` Get the internal ID of this collection
`Bitstream`	`getLogo()` Get the logo for the community.
`String`	`getMetadata(String field)` Deprecated.
`String`	`getName()` Get a proper name for the object.
`Community`	`getParentCommunity()` Return the parent community of this community, or null if the community is top-level
`DSpaceObject`	`getParentObject()` Return the dspace object that "own" the current object in the hierarchy.
`Community[]`	`getSubcommunities()` Get the immediate sub-communities of this community.
`int`	`getType()` return type found in Constants
`int`	`hashCode()`
`void`	`removeAdministrators()` Remove the administrators group, if no group has already been created then return without error.
`void`	`removeCollection(Collection c)` Remove a collection.
`void`	`removeSubcommunity(Community c)` Remove a subcommunity.
`Bitstream`	`setLogo(InputStream is)` Give the community a logo.
`void`	`setMetadata(String field, String value)` Deprecated.
`void`	`update()` Update the community metadata (including logo) to the database.
`void`	`updateLastModified()`

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
- Method Detail
  - find
```
public static Community find(Context context,
             int id)
                      throws SQLException
```
    Get a community from the database. Loads in the metadata
    
    Parameters:
    context - DSpace context object
    id - ID of the community
    
    Returns:
    the community, or null if the ID is invalid.
    
    Throws:
    
    SQLException
  - create
```
public static Community create(Community parent,
               Context context)
                        throws SQLException,
                               AuthorizeException
```
    Create a new top-level community, with a new ID.
    
    Parameters:
    context - DSpace context object
    
    Returns:
    the newly created community
    
    Throws:
    
    SQLException
    
    AuthorizeException
  - create
```
public static Community create(Community parent,
               Context context,
               String handle)
                        throws SQLException,
                               AuthorizeException
```
    Create a new top-level community, with a new ID.
    
    Parameters:
    context - DSpace context object
    handle - the pre-determined Handle to assign to the new community
    
    Returns:
    the newly created community
    
    Throws:
    
    SQLException
    
    AuthorizeException
  - findAll
```
public static Community[] findAll(Context context)
                           throws SQLException
```
    Get a list of all communities in the system. These are alphabetically sorted by community name.
    
    Parameters:
    context - DSpace context object
    
    Returns:
    the communities in the system
    
    Throws:
    
    SQLException
  - findAllTop
```
public static Community[] findAllTop(Context context)
                              throws SQLException
```
    Get a list of all top-level communities in the system. These are alphabetically sorted by community name. A top-level community is one without a parent community.
    
    Parameters:
    context - DSpace context object
    
    Returns:
    the top-level communities in the system
    
    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
```
@Deprecated
public String getMetadata(String field)
```
    Deprecated.
    
    Get the value of a metadata field
    
    Overrides:
    
    getMetadata in class DSpaceObject
    
    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
```
@Deprecated
public void setMetadata(String field,
                          String value)
                 throws MissingResourceException
```
    Deprecated.
    
    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 community. null is return if the community does not have a logo.
    
    Returns:
    the logo of the community, or null
  - setLogo
```
public Bitstream setLogo(InputStream is)
                  throws AuthorizeException,
                         IOException,
                         SQLException
```
    Give the community 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(/code> 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
  update public void update() throws SQLException, AuthorizeException Update the community metadata (including logo) to the database. Specified by: update in class DSpaceObject Throws: SQLException AuthorizeException 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 community 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 community 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 community. The default group of administrators for community 100 is the one called community_100_admin. Returns: group of administrators, or null if there is no default group. getCollections public Collection[] getCollections() throws SQLException Get the collections in this community. Throws an SQLException because creating a community object won't load in all collections. Returns: array of Collection objects Throws: SQLException getSubcommunities public Community[] getSubcommunities() throws SQLException Get the immediate sub-communities of this community. Throws an SQLException because creating a community object won't load in all collections. Returns: array of Community objects Throws: SQLException getParentCommunity public Community getParentCommunity() throws SQLException Return the parent community of this community, or null if the community is top-level Returns: the immediate parent community, or null if top-level Throws: SQLException getAllParents public Community[] getAllParents() throws SQLException Return an array of parent communities of this community, in ascending order. If community is top-level, return an empty array. Returns: an array of parent communities, empty if top-level Throws: SQLException getAllCollections public Collection[] getAllCollections() throws SQLException Return an array of collections of this community and its subcommunities Returns: an array of collections Throws: SQLException createCollection public Collection createCollection() throws SQLException, AuthorizeException Create a new collection within this community. The collection is created without any workflow groups or default submitter group. Returns: the new collection Throws: SQLException AuthorizeException createCollection public Collection createCollection(String handle) throws SQLException, AuthorizeException Create a new collection within this community. The collection is created without any workflow groups or default submitter group. Parameters: handle - the pre-determined Handle to assign to the new community Returns: the new collection Throws: SQLException AuthorizeException addCollection public void addCollection(Collection c) throws SQLException, AuthorizeException Add an exisiting collection to the community Parameters: c - collection to add Throws: SQLException AuthorizeException createSubcommunity public Community createSubcommunity() throws SQLException, AuthorizeException Create a new sub-community within this community. Returns: the new community Throws: SQLException AuthorizeException createSubcommunity public Community createSubcommunity(String handle) throws SQLException, AuthorizeException Create a new sub-community within this community. Parameters: handle - the pre-determined Handle to assign to the new community Returns: the new community Throws: SQLException AuthorizeException addSubcommunity public void addSubcommunity(Community c) throws SQLException, AuthorizeException Add an exisiting community as a subcommunity to the community Parameters: c - subcommunity to add Throws: SQLException AuthorizeException removeCollection public void removeCollection(Collection c) throws SQLException, AuthorizeException, IOException Remove a collection. If it only belongs to one parent community, then it is permanently deleted. If it has more than one parent community, it is simply unmapped from the current community. Parameters: c - collection to remove Throws: SQLException AuthorizeException IOException removeSubcommunity public void removeSubcommunity(Community c) throws SQLException, AuthorizeException, IOException Remove a subcommunity. If it only belongs to one parent community, then it is permanently deleted. If it has more than one parent community, it is simply unmapped from the current community. Parameters: c - subcommunity to remove Throws: SQLException AuthorizeException IOException delete public void delete() throws SQLException, AuthorizeException, IOException Delete the community, including the metadata and logo. Any children (subcommunities or collections) are also deleted. Throws: SQLException AuthorizeException IOException equals public boolean equals(Object other) Return true if other is the same Community 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 community 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: type of the object canEditBoolean public boolean canEditBoolean() throws SQLException return TRUE if context's user can edit community, false otherwise Returns: boolean true = current user can edit community Throws: SQLException canEdit public void canEdit() throws AuthorizeException, SQLException Throws: AuthorizeException SQLException countItems public int countItems() throws SQLException counts items in this community 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 Community

Field Summary

Fields inherited from class org.dspace.content.DSpaceObject

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

Method Detail

find

create

create

findAll

findAllTop

getID

getHandle

getMetadata

setMetadata

getName

getLogo

setLogo

update

createAdministrators

removeAdministrators

getAdministrators

getCollections

getSubcommunities

getParentCommunity

getAllParents

getAllCollections

createCollection

createCollection

addCollection

createSubcommunity

createSubcommunity

addSubcommunity

removeCollection

removeSubcommunity

delete

equals

hashCode

getType

canEditBoolean

canEdit

countItems

getAdminObject

getParentObject

updateLastModified