it.eng.rdlab.soa3.um.rest
Interface IUserManagementService.GroupManager

All Known Implementing Classes:

GroupManagerImpl

Enclosing interface:

IUserManagementService

public static interface IUserManagementService.GroupManager

The group interface in the user management hierarchy.

Version:

1.0

Author:

Ermanno Travaglino

Method Summary

String	createGroup(String groupName, String organizationName, String description, String adminUserId, String adminPassword) Creates a new group by groupName (and organizationName)
boolean	deleteGroup(String groupName, String organizationName, String adminUserId, String adminPassword) Deletes a group by groupName (and by organizationName)
boolean	deleteGroups(String organizationName, String adminUserId, String adminPassword) Deletes all present groups under an organization by organizationName
GroupModel	getGroup(String groupName, String organizationName, String adminUserId, String adminPassword) Gets the group by groupName (and by organizatioName)
List<GroupModel>	listGroupsByOrganization(String organizationName, String adminUserId, String adminPassword) Lists all groups under an organization by organizationName
boolean	removeAllUsers(String groupName, String organizationName, String adminUserId, String adminPassword) Removes all users with a specific groupName group (and by organizationName)
boolean	updateGroup(GroupModel group, String organizationName, String adminUserId, String adminPassword) Updates group's attribute

Method Detail

createGroup

String createGroup(String groupName,
                   String organizationName,
                   String description,
                   String adminUserId,
                   String adminPassword)

Creates a new group by groupName (and organizationName)

Parameters:

groupName -

organizationName -

adminUserId -

adminPassword -

Returns:

group creation process response String

deleteGroup

boolean deleteGroup(String groupName,
                    String organizationName,
                    String adminUserId,
                    String adminPassword)

Deletes a group by groupName (and by organizationName)

Parameters:

groupName -

organizationName -

adminUserId -

adminPassword -

Returns:

true if the group was removed as a result of this call

deleteGroups

boolean deleteGroups(String organizationName,
                     String adminUserId,
                     String adminPassword)

Deletes all present groups under an organization by organizationName

Parameters:

organizationName -

adminUserId -

adminPassword -

Returns:

true if the group have been removed as a result of this call

updateGroup

boolean updateGroup(GroupModel group,
                    String organizationName,
                    String adminUserId,
                    String adminPassword)

Updates group's attribute

Parameters:

group -

organizationName -

adminUserId -

adminPassword -

Returns:

true if this group updated as a result of the call

getGroup

GroupModel getGroup(String groupName,
                    String organizationName,
                    String adminUserId,
                    String adminPassword)

Gets the group by groupName (and by organizatioName)

Parameters:

groupName -

organizationName -

adminUserId -

adminPassword -

Returns:

object with specified name GroupModel

removeAllUsers

boolean removeAllUsers(String groupName,
                       String organizationName,
                       String adminUserId,
                       String adminPassword)

Removes all users with a specific groupName group (and by organizationName)

Parameters:

groupName -

organizationName -

adminUserId -

adminPassword -

Returns:

true if the group was removed from all users as a result of this call

listGroupsByOrganization

List<GroupModel> listGroupsByOrganization(String organizationName,
                                          String adminUserId,
                                          String adminPassword)

Lists all groups under an organization by organizationName

Parameters:

organizationName -

adminUserId -

adminPassword -

Returns:

a List containing all groups by organization as a result of the call