com.lexmark.saperion.client.administration

Interface RoleClient

All Known Implementing Classes:

RoleClientImpl

public interface RoleClient

This client provides methods for administrating a given role.

Author:

tfrisch

Method Summary

Modifier and Type	Method and Description
void	delete() This method deletes the role.
List<AclReferenceType>	getACLs() This method returns the ACLs currently set on the role.
RoleType	load() This method loads the role.
void	undelete() This method un-deletes the role.
void	update(RolePropertiesType properties) This method updates the role with the given properties.

Method Detail

delete

void delete()
     throws EcmException

This method deletes the role.

Throws:

EcmException - indicates that a system exception occurred

undelete

void undelete()
       throws EcmException

This method un-deletes the role.

Throws:

EcmException - indicates that a system exception occurred

load

RoleType load()
       throws EcmException

This method loads the role.

Returns:

the referenced role

Throws:

SystemException - indicates that a system exception occurred

EcmException

update

void update(RolePropertiesType properties)
     throws EcmException

This method updates the role with the given properties.

Parameters:

properties - the new properties of the role

Throws:

SystemException - indicates that a system exception occurred

EcmException

getACLs

List<AclReferenceType> getACLs()
                        throws EcmException

This method returns the ACLs currently set on the role.

Returns:

the ACLs currently set on the role

Throws:

EcmException - when loading the ACLs failed