org.proteios.core.data
Class GroupData

java.lang.Object
  org.proteios.core.data.BasicData
      org.proteios.core.data.GroupData

All Implemented Interfaces:

IdentifiableData, NameableData, RemovableData, SystemData

public class GroupData
extends BasicData
implements NameableData, RemovableData, SystemData

This class holds information about a group.

Version:

2.0

Author:

Nicklas

See Also:

Group, Authentication overview

Last modified

$Date: 2009-04-09 08:48:11 +0200 (Thu, 09 Apr 2009) $

Hibernate: class

table="`Groups`" lazy="false"

Field Summary

Fields inherited from interface org.proteios.core.data.NameableData

MAX_DESCRIPTION_LENGTH, MAX_NAME_LENGTH

Constructor Summary

GroupData()

Method Summary

Set<GroupData>	getChildren() Get the set that manages which other groups are members of this group.
String	getDescription() Get the description for the item.
String	getName() Get the name of the item.
QuotaData	getQuota() Get the quota object which holds quota information for this group.
String	getSystemId() Get the system id for the item.
Set<UserData>	getUsers() Get the set that manages which users are members of this group.
boolean	isRemoved() Check if the removed flag is set for this item.
void	setDescription(String description) Set the description for the item.
void	setName(String name) Set the name of the item.
void	setQuota(QuotaData quota)
void	setRemoved(boolean removed) Set the removed flag for this item.
void	setSystemId(String systemId)

Methods inherited from class org.proteios.core.data.BasicData

equals, getId, getVersion, hashCode, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.proteios.core.data.IdentifiableData

getId, getVersion

Constructor Detail

GroupData

public GroupData()

Method Detail

getName

public String getName()

Description copied from interface: NameableData

Get the name of the item.

Specified by:

getName in interface NameableData

Returns:

A String with the name of the item

setName

public void setName(String name)

Description copied from interface: NameableData

Set the name of the item. The name cannot be null and mustn't be longer than the value specified by the MAX_NAME_LENGTH constant.

Specified by:

setName in interface NameableData

Parameters:

name - The new name for the item

getDescription

public String getDescription()

Description copied from interface: NameableData

Get the description for the item.

Specified by:

getDescription in interface NameableData

Returns:

A String with a description of the item

setDescription

public void setDescription(String description)

Description copied from interface: NameableData

Set the description for the item. The description can be null but mustn't be longer than the value specified by the MAX_DESCRIPTION_LENGTH constant.

Specified by:

setDescription in interface NameableData

Parameters:

description - The new description for the item

isRemoved

public boolean isRemoved()

Description copied from interface: RemovableData

Check if the removed flag is set for this item.

Specified by:

isRemoved in interface RemovableData

Returns:

TRUE if the item is flagged as removed, FALSE otherwise

setRemoved

public void setRemoved(boolean removed)

Description copied from interface: RemovableData

Set the removed flag for this item.

Specified by:

setRemoved in interface RemovableData

Parameters:

removed - TRUE if the item should be flagged as removed, FALSE otherwise

getSystemId

public String getSystemId()

Description copied from interface: SystemData

Get the system id for the item.

Specified by:

getSystemId in interface SystemData

Returns:

The id of the item or null

setSystemId

public void setSystemId(String systemId)

getUsers

public Set<UserData> getUsers()

Get the set that manages which users are members of this group.

Hibernate: set

table="`UserGroups`" lazy="true"

Hibernate: collection-key

column="`group_id`"

Hibernate: collection-many-to-many

column="`user_id`" class="org.proteios.core.data.UserData"

getChildren

public Set<GroupData> getChildren()

Get the set that manages which other groups are members of this group.

Hibernate: set

table="`GroupGroups`" lazy="true"

Hibernate: collection-key

column="`parent_id`"

Hibernate: collection-many-to-many

column="`child_id`" class="org.proteios.core.data.GroupData"

getQuota

public QuotaData getQuota()

Get the quota object which holds quota information for this group.

Hibernate: many-to-one

column="`quota_id`" not-null="false" outer-join="false"

setQuota

public void setQuota(QuotaData quota)