org.olat.group
Interface BusinessGroup

All Superinterfaces:

CreateInfo, ModifiedInfo, OLATResourceable, Persistable, java.io.Serializable

All Known Implementing Classes:

BusinessGroupImpl

public interface BusinessGroup
extends Persistable, CreateInfo, ModifiedInfo, OLATResourceable

Initial Date: Aug 2, 2004

Author:

gnaegi
Comment: All OLAT business group implementation share this interface. Examples are the buddygroups or the learning groups

Field Summary

static java.lang.String	TYPE_BUDDYGROUP group type: buddygroup *
static java.lang.String	TYPE_LEARNINGROUP group type: learning group *
static java.lang.String	TYPE_RIGHTGROUP group type: course right group *
static java.lang.String	VALID_GROUPNAME_REGEXP regular expression to check for valid group names

Method Summary

java.lang.Boolean	getAutoCloseRanksEnabled()
java.lang.String	getDescription()
BGContext	getGroupContext()
java.util.Date	getLastUsage()
java.lang.Integer	getMaxParticipants()
java.lang.Integer	getMinParticipants()
java.lang.String	getName()
SecurityGroup	getOwnerGroup() The BusinessGroup has 1..n Owners acting as administrators .
SecurityGroup	getPartipiciantGroup() The BusinessGroup has 0..n Partipiciants.
java.lang.String	getType()
SecurityGroup	getWaitingGroup() The BusinessGroup has 0..n people in the waiting group.
java.lang.Boolean	getWaitingListEnabled()
void	setAutoCloseRanksEnabled(java.lang.Boolean autoCloseRanksEnabled)
void	setDescription(java.lang.String description)
void	setGroupContext(BGContext groupContext)
void	setLastUsage(java.util.Date lastUsage) BusinessGroup was active, lastUsage will be used to determine which groups should get deleted by the big administrator.
void	setMaxParticipants(java.lang.Integer maxParticipants)
void	setMinParticipants(java.lang.Integer minParticipants)
void	setName(java.lang.String name)
void	setWaitingGroup(SecurityGroup waitingGroup)
void	setWaitingListEnabled(java.lang.Boolean waitingListEnabled)

Methods inherited from interface org.olat.core.id.Persistable

equalsByPersistableKey, getKey

Methods inherited from interface org.olat.core.id.CreateInfo

getCreationDate

Methods inherited from interface org.olat.core.id.ModifiedInfo

getLastModified, setLastModified

Methods inherited from interface org.olat.core.id.OLATResourceable

getResourceableId, getResourceableTypeName

Field Detail

TYPE_BUDDYGROUP

static final java.lang.String TYPE_BUDDYGROUP

group type: buddygroup *

See Also:

Constant Field Values

TYPE_LEARNINGROUP

static final java.lang.String TYPE_LEARNINGROUP

group type: learning group *

See Also:

Constant Field Values

TYPE_RIGHTGROUP

static final java.lang.String TYPE_RIGHTGROUP

group type: course right group *

See Also:

Constant Field Values

VALID_GROUPNAME_REGEXP

static final java.lang.String VALID_GROUPNAME_REGEXP

regular expression to check for valid group names

See Also:

Constant Field Values

Method Detail

getType

java.lang.String getType()

Returns:

The group type identification

getName

java.lang.String getName()

Returns:

The group display name (not system unique)

setName

void setName(java.lang.String name)

Parameters:

name - The group display name. Must never be NULL

getDescription

java.lang.String getDescription()

Returns:

The group description or NULL if none set.

setLastUsage

void setLastUsage(java.util.Date lastUsage)

BusinessGroup was active, lastUsage will be used to determine which groups should get deleted by the big administrator.

Parameters:

lastUsage -

setDescription

void setDescription(java.lang.String description)

Parameters:

description - the description of this group. Might be NULL

getOwnerGroup

SecurityGroup getOwnerGroup()

The BusinessGroup has 1..n Owners acting as administrators .

Returns:

the owners

getPartipiciantGroup

SecurityGroup getPartipiciantGroup()

The BusinessGroup has 0..n Partipiciants.

Returns:

the partipiciants

getWaitingGroup

SecurityGroup getWaitingGroup()

The BusinessGroup has 0..n people in the waiting group.

Returns:

the waiting group

getLastUsage

java.util.Date getLastUsage()

Returns:

last usage of this group

getGroupContext

BGContext getGroupContext()

Returns:

the business group context for this group

setGroupContext

void setGroupContext(BGContext groupContext)

Parameters:

groupContext - the business group context

getMaxParticipants

java.lang.Integer getMaxParticipants()

Returns:

the maximal number of participants

setMaxParticipants

void setMaxParticipants(java.lang.Integer maxParticipants)

Parameters:

maxParticipants - the maximal number of participants

getMinParticipants

java.lang.Integer getMinParticipants()

Returns:

the minimal number of participants

setMinParticipants

void setMinParticipants(java.lang.Integer minParticipants)

Parameters:

minParticipants - the minimal number of participants

getAutoCloseRanksEnabled

java.lang.Boolean getAutoCloseRanksEnabled()

Returns:

true: if the waiting list will automaticly close ranks to participant list

setAutoCloseRanksEnabled

void setAutoCloseRanksEnabled(java.lang.Boolean autoCloseRanksEnabled)

Parameters:

autoCloseRanksEnabled - true: enable automaticly close ranks form waiting list to participant list.

getWaitingListEnabled

java.lang.Boolean getWaitingListEnabled()

Returns:

true: if waiting-list is enabled

setWaitingListEnabled

void setWaitingListEnabled(java.lang.Boolean waitingListEnabled)

Parameters:

waitinglistEnabled - true: enable waiting list.

setWaitingGroup

void setWaitingGroup(SecurityGroup waitingGroup)

Parameters:

waitingGroup - New waiting group.