Package edm.edom3

Interface EDMGroup

All Superinterfaces:

EDMContextDependent, EDMData, EDMUserOrGroup

public interface EDMGroup
extends EDMUserOrGroup

Interface wrapping an EDMdatabase use

Author:

aet

Method Summary

Modifier and Type	Method	Description
void	addMember(EDMUser user)	Add a user to this group
EDMUser[]	getAllMembers()	Retrieve a list of all group members
java.lang.String	getDescription()	Retrieve a list of all group members
boolean	hasMember(EDMUser user)	Check if a user is member in this group
void	removeMember(EDMUser user)	Add a user to this group
void	setDescription(java.lang.String description)	Set optional description of this group

Methods inherited from interface edm.edom3.EDMContextDependent

getContext

Methods inherited from interface edm.edom3.EDMData

exists, getInstanceId, getName, getOwner, isLocal, isRemote

Methods inherited from interface edm.edom3.EDMUserOrGroup

create, delete, equals, isGroup, isUser

Method Detail

addMember

void addMember(EDMUser user)
        throws EdmiException

Add a user to this group

Parameters:

user - user to add

Throws:

EdmiException - if the method fails

removeMember

void removeMember(EDMUser user)
           throws EdmiException

Add a user to this group

Parameters:

user - user to add

Throws:

EdmiException - if the method fails

hasMember

boolean hasMember(EDMUser user)
           throws EdmiException

Check if a user is member in this group

Parameters:

user - check membership for this user

Returns:

true if the user is member

Throws:

EdmiException - if the method fails

getAllMembers

EDMUser[] getAllMembers()
                 throws EdmiException

Retrieve a list of all group members

Returns:

list of group members

Throws:

EdmiException - if the method fails

getDescription

java.lang.String getDescription()
                         throws EdmiException

Retrieve a list of all group members

Returns:

list of group members

Throws:

EdmiException - if the method fails

setDescription

void setDescription(java.lang.String description)
             throws EdmiException

Set optional description of this group

Parameters:

description - description of this group

Throws:

EdmiException - if the method fails