org.olat.group.area
Interface BGArea

All Superinterfaces:

CreateInfo, Persistable, java.io.Serializable, ShortName

All Known Implementing Classes:

BGAreaImpl

public interface BGArea
extends Persistable, CreateInfo, ShortName

Description:
A business group area is used to build a (learning) context for some groups within a group context. A group can be in more than one group areas and an area can have many groups. Scenarios are: learning area 'enrollment' contains group 'class 1' and 'class 2'.

Initial Date: Aug 23, 2004

Author:

gnaegi

Field Summary

static java.lang.String

VALID_AREANAME_REGEXP regular expression to check for valid area names

Method Summary

java.lang.String	getDescription()
BGContext	getGroupContext()
java.lang.String	getName()
void	setDescription(java.lang.String description)
void	setGroupContext(BGContext groupContext)
void	setName(java.lang.String name)

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.gui.ShortName

getShortName

Field Detail

VALID_AREANAME_REGEXP

static final java.lang.String VALID_AREANAME_REGEXP

regular expression to check for valid area names

See Also:

Constant Field Values

Method Detail

getDescription

java.lang.String getDescription()

Returns:

The group area description

setDescription

void setDescription(java.lang.String description)

Parameters:

description - the group area description

getGroupContext

BGContext getGroupContext()

Returns:

The group context

setGroupContext

void setGroupContext(BGContext groupContext)

Parameters:

groupContext - The group context

getName

java.lang.String getName()

Returns:

The group area name

setName

void setName(java.lang.String name)

Parameters:

name - The group area name