com.lexmark.saperion.client.administration

Interface GroupClient

All Known Implementing Classes:

GroupClientImpl

public interface GroupClient

This client provides methods for administrating a given group.

Author:

jschwarz

Method Summary

Modifier and Type	Method and Description
void	delete() This method deletes the group.
void	deleteExtension() This method deletes the schema-extension properties of the group.
List<AclReferenceType>	getACLs() This method returns the ACLs currently set on the group.
Map<String,PropertyType>	getExtension() This method returns the schema-extension properties of the group.
GroupMembershipClientForGroups	getGroupMembers() This method returns the group membership management component for groups for the given group.
GroupMembershipClientForUsers	getUserMembers() This method returns the group membership management component for users for the given group.
GroupType	load() This method loads the group.
void	setExtension(Map<String,PropertyType> extension) This method sets the schema-extension properties of the group.
void	undelete() This method un-deletes the group.
void	update(GroupPropertiesType properties) This method updates the group with the given properties.

Method Detail

delete

void delete()
     throws EcmException

This method deletes the group.

Throws:

EcmException - indicates that a system exception occurred

undelete

void undelete()
       throws EcmException

This method un-deletes the group.

Throws:

EcmException - indicates that a system exception occurred

load

GroupType load()
        throws EcmException

This method loads the group.

Returns:

the group referenced

Throws:

SystemException - indicates that a system exception occurred

EcmException

update

void update(GroupPropertiesType properties)
     throws EcmException

This method updates the group with the given properties.

Parameters:

properties - the properties to change

Throws:

SystemException - indicates that a system exception occurred

EcmException

getGroupMembers

GroupMembershipClientForGroups getGroupMembers()

This method returns the group membership management component for groups for the given group.

Returns:

the group membership management component

getUserMembers

GroupMembershipClientForUsers getUserMembers()

This method returns the group membership management component for users for the given group.

Returns:

the group membership management component

getExtension

Map<String,PropertyType> getExtension()
                               throws EcmException

This method returns the schema-extension properties of the group.

Returns:

schema-extension properties of the group

Throws:

EcmException - when the schema-extension properties could not be loaded

setExtension

void setExtension(Map<String,PropertyType> extension)
           throws EcmException

This method sets the schema-extension properties of the group. Note that only non-null values will be updated when a schema-extension already exists.

Parameters:

extension - schema-extension properties

Throws:

EcmException - when the schema-extension properties could not be set

deleteExtension

void deleteExtension()
              throws EcmException

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

Throws:

EcmException - when the schema-extension properties could not be deleted

getACLs

List<AclReferenceType> getACLs()
                        throws EcmException

This method returns the ACLs currently set on the group.

Returns:

the ACLs currently set on the group

Throws:

EcmException - when loading the ACLs failed