Package org.dspace.content.service

Interface CommunityService

All Superinterfaces:

DSpaceObjectLegacySupportService<Community>, DSpaceObjectService<Community>

All Known Implementing Classes:

CommunityServiceImpl

public interface CommunityService
extends DSpaceObjectService<Community>, DSpaceObjectLegacySupportService<Community>

Service interface class for the Community object. The implementation of this class is responsible for all business logic calls for the Community object and is autowired by spring

Author:

kevinvandevelde at atmire.com

Method Summary

Modifier and Type	Method	Description
void	addCollection(Context context, Community community, Collection collection)	Add an exisiting collection to the community
void	addSubcommunity(Context context, Community parentCommunity, Community childCommunity)	Add an existing 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.
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)
List<Collection>	getAllCollections(Context context, Community community)	Return an array of collections of this community and its subcommunities
List<Community>	getAllParents(Context context, Collection collection)	Return an array of parent communities of this collection.
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)	Deprecated.
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 c)	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)	Deprecated.

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

findByIdOrLegacyId, findByLegacyId, getSupportsTypeConstant

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

addAndShiftRightMetadata, addMetadata, addMetadata, addMetadata, addMetadata, addMetadata, addMetadata, addMetadata, addMetadata, clearMetadata, delete, find, getAdminObject, getIdentifiers, getMetadata, getMetadata, getMetadata, getMetadataByMetadataString, getMetadataFirstValue, getName, getParentObject, getSupportsTypeConstant, getTypeText, moveMetadata, removeMetadataValues, replaceMetadata, setMetadataModified, setMetadataSingleValue, update, updateLastModified

Method Detail

create

Community create(Community parent,
                 Context context)
          throws SQLException,
                 AuthorizeException

Create a new top-level community, with a new ID.

Parameters:

parent - parent community

context - DSpace context object

Returns:

the newly created community

Throws:

SQLException - if database error

AuthorizeException - if authorization error

create

Community create(Community parent,
                 Context context,
                 String handle)
          throws SQLException,
                 AuthorizeException

Create a new top-level community, with a new ID.

Parameters:

parent - parent community

context - DSpace context object

handle - the pre-determined Handle to assign to the new community

Returns:

the newly created community

Throws:

SQLException - if database error

AuthorizeException - if authorization error

findAll

List<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 - if database error

findAll

List<Community> findAll(Context context,
                        Integer limit,
                        Integer offset)
                 throws SQLException

Get all communities in the system. Adds support for limit and offset.

Parameters:

context - context

limit - limit

offset - offset

Returns:

list of communities

Throws:

SQLException - if database error

findAllTop

List<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 - if database error

getMetadata

@Deprecated
String getMetadata(Community community,
                   String field)

Deprecated.

Get the value of a metadata field

Specified by:

getMetadata in interface DSpaceObjectService<Community>

Parameters:

community - community

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
void setMetadata(Context context,
                 Community community,
                 String field,
                 String value)
          throws MissingResourceException,
                 SQLException

Deprecated.

Set a metadata value

Parameters:

context - context

community - community

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 - if resource missing

SQLException - if database error

setLogo

Bitstream setLogo(Context context,
                  Community community,
                  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 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:

context - context

community - community

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:

IOException - if IO error

SQLException - if database error

AuthorizeException - if authorization error

createAdministrators

Group createAdministrators(Context context,
                           Community community)
                    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.

Parameters:

context - context

community - community

Returns:

the default group of editors associated with this community

Throws:

SQLException - if database error

AuthorizeException - if authorization error

removeAdministrators

void removeAdministrators(Context context,
                          Community community)
                   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.

Parameters:

context - context

community - community

Throws:

SQLException - if database error

AuthorizeException - if authorization error

getAllParents

List<Community> getAllParents(Context context,
                              Community community)
                       throws SQLException

Return an array of parent communities of this community, in ascending order. If community is top-level, return an empty array.

Parameters:

context - context

community - community

Returns:

an array of parent communities, empty if top-level

Throws:

SQLException - if database error

getAllParents

List<Community> getAllParents(Context context,
                              Collection collection)
                       throws SQLException

Return an array of parent communities of this collection.

Parameters:

context - The relevant DSpace Context.

collection - collection to check

Returns:

an array of parent communities

Throws:

SQLException - if database error

getAllCollections

List<Collection> getAllCollections(Context context,
                                   Community community)
                            throws SQLException

Return an array of collections of this community and its subcommunities

Parameters:

context - context

community - community

Returns:

an array of collections

Throws:

SQLException - if database error

addCollection

void addCollection(Context context,
                   Community community,
                   Collection collection)
            throws SQLException,
                   AuthorizeException

Add an exisiting collection to the community

Parameters:

context - context

community - community

collection - collection to add

Throws:

SQLException - if database error

AuthorizeException - if authorization error

createSubcommunity

Community createSubcommunity(Context context,
                             Community parentCommunity)
                      throws SQLException,
                             AuthorizeException

Create a new sub-community within this community.

Parameters:

context - context

parentCommunity - parent community

Returns:

the new community

Throws:

SQLException - if database error

AuthorizeException - if authorization error

createSubcommunity

Community createSubcommunity(Context context,
                             Community parentCommunity,
                             String handle)
                      throws SQLException,
                             AuthorizeException

Create a new sub-community within this community.

Parameters:

context - context

handle - the pre-determined Handle to assign to the new community

parentCommunity - parent community

Returns:

the new community

Throws:

SQLException - if database error

AuthorizeException - if authorization error

addSubcommunity

void addSubcommunity(Context context,
                     Community parentCommunity,
                     Community childCommunity)
              throws SQLException,
                     AuthorizeException

Add an existing community as a subcommunity to the community

Parameters:

context - context

parentCommunity - parent community to add our subcommunity to

childCommunity - subcommunity to add

Throws:

SQLException - if database error

AuthorizeException - if authorization error

removeCollection

void removeCollection(Context context,
                      Community community,
                      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:

context - context

c - collection to remove

community - community

Throws:

SQLException - if database error

AuthorizeException - if authorization error

IOException - if IO error

removeSubcommunity

void removeSubcommunity(Context context,
                        Community parentCommunity,
                        Community childCommunity)
                 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:

context - context

childCommunity - subcommunity to remove

parentCommunity - parent community

Throws:

SQLException - if database error

AuthorizeException - if authorization error

IOException - if IO error

canEditBoolean

boolean canEditBoolean(Context context,
                       Community community)
                throws SQLException

return TRUE if context's user can edit community, false otherwise

Parameters:

context - context

community - community

Returns:

boolean true = current user can edit community

Throws:

SQLException - if database error

canEdit

void canEdit(Context context,
             Community community)
      throws AuthorizeException,
             SQLException

Throws:

AuthorizeException

SQLException

findByAdminGroup

Community findByAdminGroup(Context context,
                           Group group)
                    throws SQLException

Throws:

SQLException

findAuthorized

List<Community> findAuthorized(Context context,
                               List<Integer> actions)
                        throws SQLException

Throws:

SQLException

findAuthorizedGroupMapped

List<Community> findAuthorizedGroupMapped(Context context,
                                          List<Integer> actions)
                                   throws SQLException

Throws:

SQLException

countTotal

int countTotal(Context context)
        throws SQLException

Throws:

SQLException