org.olat.group.context
Interface BGContext

All Superinterfaces:

CreateInfo, OLATResourceable, Persistable, java.io.Serializable

All Known Implementing Classes:

BGContextImpl

public interface BGContext
extends Persistable, CreateInfo, OLATResourceable

Description:
A business group context is a container for groups that are used together as a set. Eg. all groups of a course, or a class with some subgroups, or a Lehrgang / Studiengang. Group contexts can be attached many courses. The group context can contain only business groups of one specific business group type. Default group contexts can only be used for one resource (one association allowed). This is configured by the setDefaultContext() method.

Initial Date: Aug 18, 2004

Author:

gnaegi

Field Summary

static java.lang.String

VALID_GROUPCONTEXTNAME_REGEXP regular expression to check for valid group context names

Method Summary

java.lang.String	getDescription()
java.util.Set	getGroupAreas()
java.lang.String	getGroupType()
java.lang.String	getName()
SecurityGroup	getOwnerGroup()
boolean	isDefaultContext()
void	setDefaultContext(boolean defaultContext) Set the default context: true means that only one resource relation is allowed
void	setDescription(java.lang.String string)
void	setName(java.lang.String string)

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.OLATResourceable

getResourceableId, getResourceableTypeName

Field Detail

VALID_GROUPCONTEXTNAME_REGEXP

static final java.lang.String VALID_GROUPCONTEXTNAME_REGEXP

regular expression to check for valid group context names

See Also:

Constant Field Values

Method Detail

getName

java.lang.String getName()

Returns:

The context name

getDescription

java.lang.String getDescription()

Returns:

The context description

setDescription

void setDescription(java.lang.String string)

Parameters:

string - The context description

setName

void setName(java.lang.String string)

Parameters:

string - The context name

getGroupAreas

java.util.Set getGroupAreas()

Returns:

The group areas of this context

getOwnerGroup

SecurityGroup getOwnerGroup()

Returns:

The owner group of this context

getGroupType

java.lang.String getGroupType()

Returns:

The group type used in this context

isDefaultContext

boolean isDefaultContext()

Returns:

boolen true: this is a default context, only one relation to a resource allowed

setDefaultContext

void setDefaultContext(boolean defaultContext)

Set the default context: true means that only one resource relation is allowed

Parameters:

defaultContext -