com.lexmark.saperion.client.implementation.administration

Class GroupClientImpl

java.lang.Object

com.lexmark.saperion.client.implementation.administration.GroupClientImpl

All Implemented Interfaces:

GroupClient

public class GroupClientImpl
extends Object
implements GroupClient

This is the default implementation of GroupClient.

Author:

jschwarz

Constructor Summary

Constructors

Constructor and Description
GroupClientImpl(com.lexmark.saperion.administration.GroupManagementService groupManagementService, com.lexmark.saperion.administration.GroupReferenceType reference)

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<com.lexmark.saperion.administration.AclReferenceType>	getACLs() This method returns the ACLs currently set on the group.
GroupMembershipClientForGroups	getGroupMembers() This method returns the group membership management component for groups for the given group.
com.lexmark.saperion.administration.ExtensionPropertiesType	getSchemaExtension() This method returns the schema-extension properties of the group.
GroupMembershipClientForUsers	getUserMembers() This method returns the group membership management component for users for the given group.
com.lexmark.saperion.administration.GroupType	load() This method loads the group.
void	setSchemaExtension(com.lexmark.saperion.administration.ExtensionPropertiesType extension) This method sets the schema-extension properties of the group.
void	undelete() This method un-deletes the group.
void	update(com.lexmark.saperion.administration.GroupPropertiesType properties) This method updates the group with the given properties.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.lexmark.saperion.client.administration.GroupClient

getExtension, setExtension

Constructor Detail

GroupClientImpl

public GroupClientImpl(com.lexmark.saperion.administration.GroupManagementService groupManagementService,
                       com.lexmark.saperion.administration.GroupReferenceType reference)

Method Detail

delete

public void delete()
            throws com.lexmark.saperion.exceptions.EcmException

Description copied from interface: GroupClient

This method deletes the group.

Specified by:

delete in interface GroupClient

Throws:

com.lexmark.saperion.exceptions.EcmException - indicates that a system exception occurred

undelete

public void undelete()
              throws com.lexmark.saperion.exceptions.EcmException

Description copied from interface: GroupClient

This method un-deletes the group.

Specified by:

undelete in interface GroupClient

Throws:

com.lexmark.saperion.exceptions.EcmException - indicates that a system exception occurred

load

public com.lexmark.saperion.administration.GroupType load()
                                                   throws com.lexmark.saperion.exceptions.EcmException

Description copied from interface: GroupClient

This method loads the group.

Specified by:

load in interface GroupClient

Returns:

the group referenced

Throws:

com.lexmark.saperion.exceptions.system.SystemException - indicates that a system exception occurred

com.lexmark.saperion.exceptions.EcmException

update

public void update(com.lexmark.saperion.administration.GroupPropertiesType properties)
            throws com.lexmark.saperion.exceptions.EcmException

Description copied from interface: GroupClient

This method updates the group with the given properties.

Specified by:

update in interface GroupClient

Parameters:

properties - the properties to change

Throws:

com.lexmark.saperion.exceptions.system.SystemException - indicates that a system exception occurred

com.lexmark.saperion.exceptions.EcmException

getGroupMembers

public GroupMembershipClientForGroups getGroupMembers()

Description copied from interface: GroupClient

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

Specified by:

getGroupMembers in interface GroupClient

Returns:

the group membership management component

getUserMembers

public GroupMembershipClientForUsers getUserMembers()

Description copied from interface: GroupClient

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

Specified by:

getUserMembers in interface GroupClient

Returns:

the group membership management component

getSchemaExtension

public com.lexmark.saperion.administration.ExtensionPropertiesType getSchemaExtension()
                                                                               throws com.lexmark.saperion.exceptions.EcmException

Description copied from interface: GroupClient

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

Specified by:

getSchemaExtension in interface GroupClient

Returns:

schema-extension properties of the group

Throws:

com.lexmark.saperion.exceptions.EcmException - when the schema-extension properties could not be loaded

setSchemaExtension

public void setSchemaExtension(com.lexmark.saperion.administration.ExtensionPropertiesType extension)
                        throws com.lexmark.saperion.exceptions.EcmException

Description copied from interface: GroupClient

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.

Specified by:

setSchemaExtension in interface GroupClient

Parameters:

extension - schema-extension properties

Throws:

com.lexmark.saperion.exceptions.EcmException - when the schema-extension properties could not be set

deleteExtension

public void deleteExtension()
                     throws com.lexmark.saperion.exceptions.EcmException

Description copied from interface: GroupClient

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

Specified by:

deleteExtension in interface GroupClient

Throws:

com.lexmark.saperion.exceptions.EcmException - when the schema-extension properties could not be deleted

getACLs

public List<com.lexmark.saperion.administration.AclReferenceType> getACLs()
                                                                   throws com.lexmark.saperion.exceptions.EcmException

Description copied from interface: GroupClient

This method returns the ACLs currently set on the group.

Specified by:

getACLs in interface GroupClient

Returns:

the ACLs currently set on the group

Throws:

com.lexmark.saperion.exceptions.EcmException - when loading the ACLs failed