com.lexmark.saperion.administration

Interface GroupManagementService

public interface GroupManagementService

The group management service provides the required operations to create, read, update and delete group entities in the user management system.

Author:

owaeldrich

Method Summary

Modifier and Type	Method and Description
void	addGroupMember(GroupReferenceType group, ActorReferenceType member) This method adds a group or user - given by its reference - to a given group.
GroupReferenceType	createGroup(GroupPropertiesType properties) This method creates a new group with the given data in the current user's tenant.
void	deleteGroup(GroupReferenceType reference) Deletes the group with the given reference.
void	deleteSchemaExtension(GroupReferenceType group) This method deletes the schema-extension of the given group.
List<AclReferenceType>	getACLs(GroupReferenceType group) This method returns the ACLs currently set on the referenced group.
Map<String,PropertyType>	getSchemaExtension(GroupReferenceType group) This method returns the schema-extension for the given group.
GroupType	loadGroup(GroupReferenceType reference) This method loads a group given a reference to it.
GroupType	loadGroupByName(String name)
SearchExecutionService<GroupListItemType>	newMembershipSearchServiceForGroups(GroupReferenceType parent) This method returns a search execution service that searches groups that are members of the given group.
SearchExecutionService<UserListItemType>	newMembershipSearchServiceForUsers(GroupReferenceType parent) This method returns a search execution service that searches users that are members of the given group.
SearchExecutionService<GroupListItemType>	newTenantDeletedGroupSearchService() This method returns a search execution service that searches deleted groups of the current user's tenant.
SearchExecutionService<GroupListItemType>	newTenantGroupSearchService() This method returns a search execution service that searches groups of the current user's tenant.
void	removeGroupMember(GroupReferenceType group, ActorReferenceType member) This method removes a member reference to the given group.
void	setSchemaExtension(GroupReferenceType group, Map<String,PropertyType> schemaExtension) This method stores the given schema-extension for the given group.
void	undeleteGroup(GroupReferenceType reference) Un-deletes the group with the given reference.
void	updateGroup(GroupReferenceType reference, GroupPropertiesType properties) Updates a group with the given properties.

Method Detail

addGroupMember

void addGroupMember(GroupReferenceType group,
                    ActorReferenceType member)
             throws EcmException

This method adds a group or user - given by its reference - to a given group.

Parameters:

group - a reference to the group the member is added to

member - a reference to the member to add

Throws:

ResourceNotFoundException - the referenced group does not exist in the backend system

SystemException - indicates that a system exception occurred

EcmException

createGroup

GroupReferenceType createGroup(GroupPropertiesType properties)
                        throws EcmException

This method creates a new group with the given data in the current user's tenant.

Parameters:

properties - the properties of the group

Returns:

a reference to the newly created group

Throws:

SystemException - indicates that a system exception occurred

EcmException

deleteGroup

void deleteGroup(GroupReferenceType reference)
          throws EcmException

Deletes the group with the given reference.

Parameters:

reference - the group reference

Throws:

ResourceNotFoundException - the referenced group does not exist in the backend system

SystemException - indicates that a system exception occurred

EcmException

undeleteGroup

void undeleteGroup(GroupReferenceType reference)
            throws EcmException

Un-deletes the group with the given reference.

Parameters:

reference - the group reference

Throws:

SystemException - indicates that a system exception occurred

EcmException

newTenantGroupSearchService

SearchExecutionService<GroupListItemType> newTenantGroupSearchService()
                                                               throws EcmException

This method returns a search execution service that searches groups of the current user's tenant.

Returns:

a list of all groups of the specified tenant

Throws:

EcmException - indicates that a system exception occurred

newTenantDeletedGroupSearchService

SearchExecutionService<GroupListItemType> newTenantDeletedGroupSearchService()
                                                                      throws EcmException

This method returns a search execution service that searches deleted groups of the current user's tenant.

Returns:

a list of all deleted groups of the specified tenant

Throws:

EcmException - indicates that a system exception occurred

loadGroup

GroupType loadGroup(GroupReferenceType reference)
             throws EcmException

This method loads a group given a reference to it.

Parameters:

reference - a reference to the group to load.

Returns:

the group referenced

Throws:

ResourceNotFoundException - the referenced group does not exist in the backend system

SystemException - indicates that a system exception occurred

EcmException

loadGroupByName

GroupType loadGroupByName(String name)
                   throws EcmException

Throws:

EcmException

newMembershipSearchServiceForGroups

SearchExecutionService<GroupListItemType> newMembershipSearchServiceForGroups(GroupReferenceType parent)

This method returns a search execution service that searches groups that are members of the given group.

Parameters:

parent - a reference to the group to search the members for

Returns:

a search execution service that searches groups that are members of the given group

newMembershipSearchServiceForUsers

SearchExecutionService<UserListItemType> newMembershipSearchServiceForUsers(GroupReferenceType parent)

This method returns a search execution service that searches users that are members of the given group.

Parameters:

parent - a reference to the group to search the members for

Returns:

a search execution service that searches users that are members of the given group

removeGroupMember

void removeGroupMember(GroupReferenceType group,
                       ActorReferenceType member)
                throws EcmException

This method removes a member reference to the given group.

Parameters:

group - a reference to the group the member is added to

member - a reference to the member to add

Throws:

ResourceNotFoundException - the referenced group or member does not exist in the backend system

SystemException - indicates that a system exception occurred

EcmException

updateGroup

void updateGroup(GroupReferenceType reference,
                 GroupPropertiesType properties)
          throws EcmException

Updates a group with the given properties.

Parameters:

reference - reference to the group to update

properties - the properties to change

Throws:

ResourceNotFoundException - the referenced group or member does not exist in the backend system

SystemException - indicates that a system exception occurred

EcmException

getSchemaExtension

Map<String,PropertyType> getSchemaExtension(GroupReferenceType group)
                                     throws EcmException

This method returns the schema-extension for the given group.

Parameters:

group - the group

Returns:

the schema-extension of the group

Throws:

EcmException

setSchemaExtension

void setSchemaExtension(GroupReferenceType group,
                        Map<String,PropertyType> schemaExtension)
                 throws EcmException

This method stores the given schema-extension for the given group. Note that only non-null values will be updated when a schema-extension already exists.

Parameters:

group - the group

schemaExtension - the schema-extension to store

Throws:

EcmException

deleteSchemaExtension

void deleteSchemaExtension(GroupReferenceType group)
                    throws EcmException

This method deletes the schema-extension of the given group.

Parameters:

group - the group

Throws:

EcmException - when deleting the schema-extension failed

getACLs

List<AclReferenceType> getACLs(GroupReferenceType group)
                        throws EcmException

This method returns the ACLs currently set on the referenced group.

Parameters:

group - a reference to the group

Returns:

the ACLs currently set on the group

Throws:

EcmException - when loading the ACLs failed