org.gcube.common.homelibrary.home.workspace.usermanager

Interface GCubeGroup

public interface GCubeGroup

Method Summary

Methods

Modifier and Type	Method and Description
boolean	addMember(String user) Adds the specified member to the group.
boolean	addMembers(List<String> users) Add a list of users
String	getDisplayName() Return a diplayName for VRE group
List<String>	getMembers() Returns a list of the members in the group.
String	getName()
boolean	isMember(String user) Returns true if the passed user is a member of the group.
boolean	removeMember(String user) Removes the specified member from the group.
boolean	removeMembers(List<String> users) Delete a list of users
boolean	setDisplayName(String displayName) Set a new diplayName for VRE group

Method Detail

getName

String getName()

addMember

boolean addMember(String user)
                  throws InternalErrorException

Adds the specified member to the group.

Parameters:

user - the user to add to this group.

Returns:

true if the member was successfully added, false if the user was already a member.

Throws:

InternalErrorException

addMembers

boolean addMembers(List<String> users)
                   throws InternalErrorException

Add a list of users

Parameters:

users -

Throws:

InternalErrorException

removeMember

boolean removeMember(String user)
                     throws InternalErrorException

Removes the specified member from the group.

Parameters:

user - the user to remove from this group.

Returns:

true if the user was removed, or false if the user was not a member.

Throws:

InternalErrorException

removeMembers

boolean removeMembers(List<String> users)
                      throws InternalErrorException

Delete a list of users

Parameters:

users -

Throws:

InternalErrorException

isMember

boolean isMember(String user)
                 throws InternalErrorException

Returns true if the passed user is a member of the group. This method does a recursive search, so if a user belongs to a group which is a member of this group, true is returned.

Parameters:

user - the user whose membership is to be checked.

Returns:

true if the user is a member of this group, false otherwise.

Throws:

InternalErrorException

getMembers

List<String> getMembers()
                        throws InternalErrorException

Returns a list of the members in the group.

Returns:

a list of the members in the group.

Throws:

InternalErrorException

getDisplayName

String getDisplayName()
                      throws InternalErrorException

Return a diplayName for VRE group

Returns:

a diplayName for VRE group

Throws:

InternalErrorException

setDisplayName

boolean setDisplayName(String displayName)
                       throws InternalErrorException

Set a new diplayName for VRE group

Parameters:

displayName -

Returns:

true if the diplayName has been updated

Throws:

InternalErrorException