CommunityServiceImpl (DSpace Kernel :: API and Implementation 6.0-rc1 API)

java.lang.Object
- org.dspace.content.DSpaceObjectServiceImpl<Community>
- - org.dspace.content.CommunityServiceImpl

All Implemented Interfaces:

CommunityService, DSpaceObjectLegacySupportService<Community>, DSpaceObjectService<Community>
```
public class CommunityServiceImpl
extends DSpaceObjectServiceImpl<Community>
implements CommunityService
```
Service implementation for the Community object. This class is responsible for all business logic calls for the Community 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 BitstreamService`	`bitstreamService`
`protected CollectionService`	`collectionService`
`protected CommunityDAO`	`communityDAO`
`protected GroupService`	`groupService`
`protected ItemService`	`itemService`
`protected SiteService`	`siteService`

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

Constructor Summary

Constructors
Modifier Constructor and Description

protected CommunityServiceImpl()

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

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`addCollection(Context context, Community community, Collection collection)` Add an exisiting collection to the community
`protected void`	`addCollectionList(Community community, List<Collection> collectionList)` Internal method to process subcommunities recursively
`void`	`addSubcommunity(Context context, Community parentCommunity, Community childCommunity)` Add an exisiting community as a subcommunity to the community
`void`	`canEdit(Context context, Community community)`
`boolean`	`canEditBoolean(Context context, Community community)` return TRUE if context's user can edit community, false otherwise
`int`	`countTotal(Context context)`
`Community`	`create(Community parent, Context context)` Create a new top-level community, with a new ID.
`Community`	`create(Community parent, Context context, String handle)` Create a new top-level community, with a new ID.
`Group`	`createAdministrators(Context context, Community community)` Create a default administrators group if one does not already exist.
`Community`	`createSubcommunity(Context context, Community parentCommunity)` Create a new sub-community within this community.
`Community`	`createSubcommunity(Context context, Community parentCommunity, String handle)` Create a new sub-community within this community.
`void`	`delete(Context context, Community community)`
`Community`	`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.
`List<Community>`	`findAll(Context context)` Get a list of all communities in the system.
`List<Community>`	`findAll(Context context, Integer limit, Integer offset)` Get all communities in the system.
`List<Community>`	`findAllTop(Context context)` Get a list of all top-level communities in the system.
`List<Community>`	`findAuthorized(Context context, List<Integer> actions)`
`List<Community>`	`findAuthorizedGroupMapped(Context context, List<Integer> actions)`
`Community`	`findByAdminGroup(Context context, Group group)`
`Community`	`findByIdOrLegacyId(Context context, String id)`
`Community`	`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.
`DSpaceObject`	`getAdminObject(Context context, Community community, int action)` Return the dspace object where an ADMIN action right is sufficient to grant the initial authorize check.
`List<Collection>`	`getAllCollections(Context context, Community community)` Return an array of collections of this community and its subcommunities
`List<Community>`	`getAllParents(Context context, Community community)` Return an array of parent communities of this community, in ascending order.
`String`	`getMetadata(Community community, String field)` Get the value of a metadata field
`DSpaceObject`	`getParentObject(Context context, Community community)` Return the dspace object that "own" the current object in the hierarchy.
`int`	`getSupportsTypeConstant()` Returns the Constants which this service supports
`protected void`	`rawDelete(Context context, Community community)` Internal method to remove the community and all its children from the database, and perform any pre/post-cleanup
`void`	`removeAdministrators(Context context, Community community)` Remove the administrators group, if no group has already been created then return without error.
`void`	`removeCollection(Context context, Community community, Collection collection)` Remove a collection.
`void`	`removeSubcommunity(Context context, Community parentCommunity, Community childCommunity)` Remove a subcommunity.
`Bitstream`	`setLogo(Context context, Community community, InputStream is)` Give the community a logo.
`void`	`setMetadata(Context context, Community community, String field, String value)` Set a metadata value
`void`	`update(Context context, Community community)`
`void`	`updateLastModified(Context context, Community community)`

Methods inherited from class org.dspace.content.DSpaceObjectServiceImpl
addMetadata, addMetadata, addMetadata, addMetadata, addMetadata, addMetadata, addMetadata, clearMetadata, deleteMetadata, getAuthoritiesAndConfidences, getElements, getElementsFilled, getIdentifiers, getMDValueByField, getMDValueByLegacyField, 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, clearMetadata, getIdentifiers, getMetadata, getMetadata, getMetadata, getMetadataByMetadataString, getMetadataFirstValue, getName, getTypeText, removeMetadataValues, setMetadataSingleValue

- Field Detail
  - communityDAO
```
@Autowired(required=true)
protected CommunityDAO communityDAO
```
  - collectionService
```
@Autowired(required=true)
protected CollectionService collectionService
```
  - groupService
```
@Autowired(required=true)
protected GroupService groupService
```
  - authorizeService
```
@Autowired(required=true)
protected AuthorizeService authorizeService
```
  - itemService
```
@Autowired(required=true)
protected ItemService itemService
```
  - bitstreamService
```
@Autowired(required=true)
protected BitstreamService bitstreamService
```
  - siteService
```
@Autowired(required=true)
protected SiteService siteService
```
- Constructor Detail
  - CommunityServiceImpl
```
protected CommunityServiceImpl()
```
- Method Detail
  - create
```
public Community create(Community parent,
               Context context)
                 throws SQLException,
                        AuthorizeException
```
    Description copied from interface: CommunityService
    
    Create a new top-level community, with a new ID.
    
    Specified by:
    
    create in interface CommunityService
    
    context - DSpace context object
    
    Returns:
    the newly created community
    
    Throws:
    
    SQLException
    
    AuthorizeException
  - create
```
public Community create(Community parent,
               Context context,
               String handle)
                 throws SQLException,
                        AuthorizeException
```
    Description copied from interface: CommunityService
    
    Create a new top-level community, with a new ID.
    
    Specified by:
    
    create in interface CommunityService
    
    context - DSpace context object
    handle - the pre-determined Handle to assign to the new community
    
    Returns:
    the newly created community
    
    Throws:
    
    SQLException
    
    AuthorizeException
  - find
```
public Community 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<Community>
    
    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.
  - findAll
```
public List<Community> findAll(Context context)
                        throws SQLException
```
    Description copied from interface: CommunityService
    
    Get a list of all communities in the system. These are alphabetically sorted by community name.
    
    Specified by:
    
    findAll in interface CommunityService
    
    Parameters:
    context - DSpace context object
    
    Returns:
    the communities in the system
    
    Throws:
    
    SQLException
  - findAll
```
public List<Community> findAll(Context context,
                      Integer limit,
                      Integer offset)
                        throws SQLException
```
    Description copied from interface: CommunityService
    
    Get all communities in the system. Adds support for limit and offset.
    
    Specified by:
    
    findAll in interface CommunityService
    
    Returns:
    
    Throws:
    
    SQLException
  - findAllTop
```
public List<Community> findAllTop(Context context)
                           throws SQLException
```
    Description copied from interface: CommunityService
    
    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.
    
    Specified by:
    
    findAllTop in interface CommunityService
    
    Parameters:
    context - DSpace context object
    
    Returns:
    the top-level communities in the system
    
    Throws:
    
    SQLException
  - getMetadata
```
public String getMetadata(Community community,
                 String field)
```
    Description copied from interface: DSpaceObjectService
    
    Get the value of a metadata field
    
    Specified by:
    
    getMetadata in interface CommunityService
    
    Specified by:
    
    getMetadata in interface DSpaceObjectService<Community>
    
    Overrides:
    
    getMetadata in class DSpaceObjectServiceImpl<Community>
    
    field - the name of the metadata field to get
    
    Returns:
    the value of the metadata field (or null if the column is an SQL NULL)
  - setMetadata
```
public void setMetadata(Context context,
               Community community,
               String field,
               String value)
                 throws MissingResourceException,
                        SQLException
```
    Description copied from interface: CommunityService
    
    Set a metadata value
    
    Specified by:
    
    setMetadata in interface CommunityService
    
    field - the name of the metadata field to get
    value - value to set the field to
    
    Throws:
    
    MissingResourceException
    
    SQLException
  - setLogo
```
public Bitstream setLogo(Context context,
                Community community,
                InputStream is)
                  throws AuthorizeException,
                         IOException,
                         SQLException
```
    Description copied from interface: CommunityService
    
    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.
    Specified by: setLogo in interface CommunityService 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(Context context, Community community) throws SQLException, AuthorizeException Specified by: update in interface DSpaceObjectService<Community> Overrides: update in class DSpaceObjectServiceImpl<Community> Throws: SQLException AuthorizeException createAdministrators public Group createAdministrators(Context context, Community community) throws SQLException, AuthorizeException Description copied from interface: CommunityService 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 CommunityService Returns: the default group of editors associated with this community Throws: SQLException AuthorizeException removeAdministrators public void removeAdministrators(Context context, Community community) throws SQLException, AuthorizeException Description copied from interface: CommunityService 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. Specified by: removeAdministrators in interface CommunityService Throws: SQLException AuthorizeException getAllParents public List<Community> getAllParents(Context context, Community community) throws SQLException Description copied from interface: CommunityService Return an array of parent communities of this community, in ascending order. If community is top-level, return an empty array. Specified by: getAllParents in interface CommunityService Returns: an array of parent communities, empty if top-level Throws: SQLException getAllCollections public List<Collection> getAllCollections(Context context, Community community) throws SQLException Description copied from interface: CommunityService Return an array of collections of this community and its subcommunities Specified by: getAllCollections in interface CommunityService Returns: an array of collections Throws: SQLException addCollectionList protected void addCollectionList(Community community, List<Collection> collectionList) throws SQLException Internal method to process subcommunities recursively Throws: SQLException addCollection public void addCollection(Context context, Community community, Collection collection) throws SQLException, AuthorizeException Description copied from interface: CommunityService Add an exisiting collection to the community Specified by: addCollection in interface CommunityService collection - collection to add Throws: SQLException AuthorizeException createSubcommunity public Community createSubcommunity(Context context, Community parentCommunity) throws SQLException, AuthorizeException Description copied from interface: CommunityService Create a new sub-community within this community. Specified by: createSubcommunity in interface CommunityService Returns: the new community Throws: SQLException AuthorizeException createSubcommunity public Community createSubcommunity(Context context, Community parentCommunity, String handle) throws SQLException, AuthorizeException Description copied from interface: CommunityService Create a new sub-community within this community. Specified by: createSubcommunity in interface CommunityService handle - the pre-determined Handle to assign to the new community Returns: the new community Throws: SQLException AuthorizeException addSubcommunity public void addSubcommunity(Context context, Community parentCommunity, Community childCommunity) throws SQLException, AuthorizeException Description copied from interface: CommunityService Add an exisiting community as a subcommunity to the community Specified by: addSubcommunity in interface CommunityService parentCommunity - parent community to add our subcommunity to childCommunity - subcommunity to add Throws: SQLException AuthorizeException removeCollection public void removeCollection(Context context, Community community, Collection collection) throws SQLException, AuthorizeException, IOException Description copied from interface: CommunityService 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. Specified by: removeCollection in interface CommunityService collection - collection to remove Throws: SQLException AuthorizeException IOException removeSubcommunity public void removeSubcommunity(Context context, Community parentCommunity, Community childCommunity) throws SQLException, AuthorizeException, IOException Description copied from interface: CommunityService 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. Specified by: removeSubcommunity in interface CommunityService childCommunity - subcommunity to remove Throws: SQLException AuthorizeException IOException delete public void delete(Context context, Community community) throws SQLException, AuthorizeException, IOException Specified by: delete in interface DSpaceObjectService<Community> 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<Community> Specified by: getSupportsTypeConstant in interface DSpaceObjectService<Community> Returns: a org.dspace.core.Constants that represents a DSpaceObjct type rawDelete protected void rawDelete(Context context, Community community) throws SQLException, AuthorizeException, IOException Internal method to remove the community and all its children from the database, and perform any pre/post-cleanup Throws: SQLException AuthorizeException IOException canEditBoolean public boolean canEditBoolean(Context context, Community community) throws SQLException Description copied from interface: CommunityService return TRUE if context's user can edit community, false otherwise Specified by: canEditBoolean in interface CommunityService Returns: boolean true = current user can edit community Throws: SQLException canEdit public void canEdit(Context context, Community community) throws AuthorizeException, SQLException Specified by: canEdit in interface CommunityService Throws: AuthorizeException SQLException findByAdminGroup public Community findByAdminGroup(Context context, Group group) throws SQLException Specified by: findByAdminGroup in interface CommunityService Throws: SQLException findAuthorized public List<Community> findAuthorized(Context context, List<Integer> actions) throws SQLException Specified by: findAuthorized in interface CommunityService Throws: SQLException findAuthorizedGroupMapped public List<Community> findAuthorizedGroupMapped(Context context, List<Integer> actions) throws SQLException Specified by: findAuthorizedGroupMapped in interface CommunityService Throws: SQLException getAdminObject public DSpaceObject getAdminObject(Context context, Community community, 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<Community> Overrides: getAdminObject in class DSpaceObjectServiceImpl<Community> 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(Context context, Community community) 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<Community> Overrides: getParentObject in class DSpaceObjectServiceImpl<Community> Returns: the dspace object that "own" the current object in the hierarchy Throws: SQLException updateLastModified public void updateLastModified(Context context, Community community) Specified by: updateLastModified in interface DSpaceObjectService<Community> findByIdOrLegacyId public Community findByIdOrLegacyId(Context context, String id) throws SQLException Specified by: findByIdOrLegacyId in interface DSpaceObjectLegacySupportService<Community> Throws: SQLException findByLegacyId public Community 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<Community> 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 CommunityService Throws: SQLException

Class CommunityServiceImpl

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

communityDAO

collectionService

groupService

authorizeService

itemService

bitstreamService

siteService

Constructor Detail

CommunityServiceImpl

Method Detail

create

create

find

findAll

findAll

findAllTop

getMetadata

setMetadata

setLogo

update

createAdministrators

removeAdministrators

getAllParents

getAllCollections

addCollectionList

addCollection

createSubcommunity

createSubcommunity

addSubcommunity

removeCollection

removeSubcommunity

delete

getSupportsTypeConstant

rawDelete

canEditBoolean

canEdit

findByAdminGroup

findAuthorized

findAuthorizedGroupMapped

getAdminObject

getParentObject

updateLastModified

findByIdOrLegacyId

findByLegacyId

countTotal