com.lexmark.saperion.client.administration

Interface RoleManagementServiceClient

All Known Implementing Classes:

RoleManagementServiceClientImpl

public interface RoleManagementServiceClient

This client provides methods for administrating rolea.

Author:

tfrisch

Method Summary

Modifier and Type	Method and Description
com.lexmark.saperion.administration.RoleReferenceType	createRole(com.lexmark.saperion.administration.RolePropertiesType properties) This method creates a new role with the given properties and returns a reference to it.
RoleClient	resolve(com.lexmark.saperion.administration.RoleReferenceType reference) This method returns an administration client for the role with the given reference.
RoleClient	resolveName(String roleName) This method returns an administration client for the role with the given name.
SearchClient<com.lexmark.saperion.administration.RoleType>	search() This method returns a search client for searching roles.
SearchClient<com.lexmark.saperion.administration.RoleType>	searchDeleted() This method returns a search client for searching deleted roles.

Method Detail

resolve

RoleClient resolve(com.lexmark.saperion.administration.RoleReferenceType reference)
            throws com.lexmark.saperion.exceptions.EcmException

This method returns an administration client for the role with the given reference.

Parameters:

reference - a reference to the role to administrate

Returns:

an administration client for the role with the given reference

Throws:

com.lexmark.saperion.exceptions.EcmException

resolveName

RoleClient resolveName(String roleName)
                throws com.lexmark.saperion.exceptions.EcmException

This method returns an administration client for the role with the given name.

Parameters:

roleName - the name of the role to administrate

Returns:

an administration client for the role with the given name

Throws:

com.lexmark.saperion.exceptions.EcmException

search

SearchClient<com.lexmark.saperion.administration.RoleType> search()
                                                           throws com.lexmark.saperion.exceptions.EcmException

This method returns a search client for searching roles.

Returns:

a search client for searching roles

Throws:

com.lexmark.saperion.exceptions.EcmException

searchDeleted

SearchClient<com.lexmark.saperion.administration.RoleType> searchDeleted()
                                                                  throws com.lexmark.saperion.exceptions.EcmException

This method returns a search client for searching deleted roles.

Returns:

a search client for searching deleted roles

Throws:

com.lexmark.saperion.exceptions.EcmException

createRole

com.lexmark.saperion.administration.RoleReferenceType createRole(com.lexmark.saperion.administration.RolePropertiesType properties)
                                                          throws com.lexmark.saperion.exceptions.EcmException

This method creates a new role with the given properties and returns a reference to it.

Parameters:

properties - the properties of the new role

Returns:

a reference to role created

Throws:

com.lexmark.saperion.exceptions.EcmException