org.sakaiproject.service.legacy.site
Interface Group

All Superinterfaces:
AuthzGroup, Comparable, Edit, Entity, Serializable
All Known Implementing Classes:
BaseGroup

public interface Group
extends Edit, Serializable, AuthzGroup

A Site Group is a way to divide up a Site into separate units, each with its own authorization group and descriptive information.

Author:
Sakai Software Development Team

Field Summary
 
Fields inherited from interface org.sakaiproject.service.legacy.entity.Entity
SEPARATOR
 
Method Summary
 Site getContainingSite()
          Access the site in which this group lives.
 String getDescription()
           
 String getTitle()
           
 void setDescription(String description)
          Set the text describing this group.
 void setTitle(String title)
          Set the human readable short title of this group.
 
Methods inherited from interface org.sakaiproject.service.legacy.entity.Edit
getPropertiesEdit, isActiveEdit
 
Methods inherited from interface org.sakaiproject.service.legacy.entity.Entity
getId, getProperties, getReference, getReference, getUrl, getUrl, toXml
 
Methods inherited from interface org.sakaiproject.service.legacy.authzGroup.AuthzGroup
addMember, addRole, addRole, getCreatedBy, getCreatedTime, getMaintainRole, getMember, getMembers, getModifiedBy, getModifiedTime, getProviderGroupId, getRole, getRoles, getRolesIsAllowed, getUserRole, getUsers, getUsersHasRole, getUsersIsAllowed, hasRole, isAllowed, isEmpty, keepIntersection, removeMember, removeMembers, removeRole, removeRoles, setMaintainRole, setProviderGroupId
 
Methods inherited from interface java.lang.Comparable
compareTo
 

Method Detail

getTitle

public String getTitle()
Returns:
a human readable short title of this group.

getDescription

public String getDescription()
Specified by:
getDescription in interface AuthzGroup
Returns:
a text describing the group.

getContainingSite

public Site getContainingSite()
Access the site in which this group lives.

Returns:
the site in which this group lives.

setTitle

public void setTitle(String title)
Set the human readable short title of this group.

Parameters:
title - The new title.

setDescription

public void setDescription(String description)
Set the text describing this group.

Parameters:
description - The new description.