pt.digitalis.dif.controller.security.objects
Interface IDIFGroup

All Superinterfaces:

Cloneable

All Known Implementing Classes:

DIFGroupImpl

public interface IDIFGroup
extends Cloneable

Defines the expected behavior of a DIF group of users.

Author:

Rodrigo Gonçalves rgoncalves@digitalis.pt
, Pedro Viegas pviegas@digitalis.pt

Created on:

2007/12/04

Method Summary

IDIFGroup	cloneGroup() Returns a new clone of the current group
String	getDescription() Returns the group description.
String	getID() Returns the group id.
String	getName() Returns the group name.
IDIFGroup	getParentGroup() Returns the parent group.
String	getParentGroupID() Returns the parent group ID.
Set<String>	getUserIDs() Retrieves the list of user IDs associated with this group
Map<String,IDIFUser>	getUsers() Retrieves the list of users associated with this group
boolean	isDefault() A default group is a group that is created by the default configuration of the application.
void	setDefault(boolean isDefault) Sets the group as a 'default group'.
void	setDescription(String newDescription) Sets a new description for the group.
void	setID(String newGroupId) Sets a new id for the group.
void	setName(String newName) Sets a new name for the group.
void	setParentGroupID(String newParent) Sets a new parent for the group.

Method Detail

getID

String getID()

Returns the group id.

Returns:

the group id

setID

void setID(String newGroupId)

Sets a new id for the group.

Parameters:

newGroupId - the new group id

getName

String getName()

Returns the group name.

Returns:

the group name

setName

void setName(String newName)

Sets a new name for the group.

Parameters:

newName - the new group name

getDescription

String getDescription()

Returns the group description.

Returns:

the group description

setDescription

void setDescription(String newDescription)

Sets a new description for the group.

Parameters:

newDescription - the new group description

getParentGroupID

String getParentGroupID()

Returns the parent group ID.

Returns:

the parent group id

setParentGroupID

void setParentGroupID(String newParent)

Sets a new parent for the group.

Parameters:

newParent - the new parent group

getParentGroup

IDIFGroup getParentGroup()
                         throws IdentityManagerException

Returns the parent group.

Returns:

the parent group

Throws:

IdentityManagerException - if the parent group can't be found on the identity manager

getUsers

Map<String,IDIFUser> getUsers()
                              throws IdentityManagerException

Retrieves the list of users associated with this group

Returns:

the groups

Throws:

IdentityManagerException - if the users can't be found on the identity manager

getUserIDs

Set<String> getUserIDs()
                       throws IdentityManagerException

Retrieves the list of user IDs associated with this group

Returns:

the groups

Throws:

IdentityManagerException - if the users can't be found on the identity manager

cloneGroup

IDIFGroup cloneGroup()

Returns a new clone of the current group

Returns:

the clone object

isDefault

boolean isDefault()

A default group is a group that is created by the default configuration of the application. As such it cannot be deleted. Only disabled.

Returns:

T if the user is a default group

setDefault

void setDefault(boolean isDefault)

Sets the group as a 'default group'.

Parameters:

isDefault - T if the group must be set as a default group, F otherwise