org.dspace.content

Class Community

java.lang.Object

org.dspace.content.DSpaceObject

org.dspace.content.Community

All Implemented Interfaces:

Serializable, DSpaceObjectLegacySupport, ReloadableEntity<UUID>, IndexableObject<UUID>

@Entity
public class Community
extends DSpaceObject
implements DSpaceObjectLegacySupport, IndexableObject<UUID>

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

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected CommunityService	communityService
static String	COPYRIGHT_TEXT
static String	INTRODUCTORY_TEXT
static String	SHORT_DESCRIPTION
static String	SIDEBAR_TEXT

Fields inherited from class org.dspace.content.DSpaceObject

id

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Community() Protected constructor, create object using: CommunityService.create(Community, Context) or CommunityService.create(Community, Context, String)

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object other) Return true if other is the same Community as this object, false otherwise
Group	getAdministrators() Get the default group of administrators, if there is one.
List<Collection>	getCollections() Get the collections in this community.
Integer	getLegacyId()
Bitstream	getLogo() Get the logo for the community.
String	getName()
List<Community>	getParentCommunities() Return the parent community of this community, or null if the community is top-level
List<Community>	getSubcommunities() Get the immediate sub-communities of this community.
int	getType() return type found in Constants
String	getTypeText()
int	hashCode()
void	removeParentCommunity(Community parentCommunity)
void	removeSubCommunity(Community subCommunity)

Methods inherited from class org.dspace.content.DSpaceObject

addDetails, addHandle, addMetadata, clearDetails, clearModified, getDetails, getHandle, getHandles, getID, getMetadata, getResourcePolicies, isMetadataModified, isModified, removeMetadata, removeMetadata, setMetadata, setMetadataModified, setModified

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.dspace.discovery.IndexableObject

getUniqueIndexID

Methods inherited from interface org.dspace.core.ReloadableEntity

getID

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

communityService

protected transient CommunityService communityService

Constructor Detail

Community

protected Community()

Protected constructor, create object using: CommunityService.create(Community, Context) or CommunityService.create(Community, Context, String)

Method Detail

removeSubCommunity

public void removeSubCommunity(Community subCommunity)

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

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 List<Collection> getCollections()

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

getSubcommunities

public List<Community> getSubcommunities()

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

getParentCommunities

public List<Community> getParentCommunities()

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

removeParentCommunity

public void removeParentCommunity(Community parentCommunity)

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 interface IndexableObject<UUID>

Specified by:

getType in class DSpaceObject

Returns:

Community type

getTypeText

public String getTypeText()

Specified by:

getTypeText in interface IndexableObject<UUID>

Returns:

a textual alias of the Entity Type @see IndexableObject.getType()

getName

public String getName()

Specified by:

getName in class DSpaceObject

getLegacyId

public Integer getLegacyId()

Specified by:

getLegacyId in interface DSpaceObjectLegacySupport

Returns:

the old integer based legacy identifier