com.lexmark.saperion.client.administration

Interface UserManagementServiceClient

All Known Implementing Classes:

UserManagementServiceClientImpl

public interface UserManagementServiceClient

This client provides functionality to administrate the users of a saperion system.

Author:

jschwarz

Method Summary

Modifier and Type	Method and Description
UserReferenceType	createUser(CreateUserPropertiesType properties) This method creates a new user with the given properties.
UserReferenceType	createUser(String shortName, String password) This is a shorthand to createUser(CreateUserPropertiesType).
UserReferenceType	createUser(String shortName, String fullName, String password, String description, String emailAddress) This method creates a new user with the given properties.
UserClient	resolve(UserReferenceType reference) This method returns an administration client for the user referenced.
UserClient	resolveName(String userName) This method returns an administration client for the user with the given name.
SearchClient<UserListItemType>	search() This method returns a search client for searching users.
SearchClient<UserListItemType>	searchDeleted() This method returns a search client for searching deleted users.

Method Detail

resolve

UserClient resolve(UserReferenceType reference)
            throws EcmException

This method returns an administration client for the user referenced.

Parameters:

reference - a reference to the user to administrate

Returns:

an administration client for the user referenced

Throws:

EcmException

resolveName

UserClient resolveName(String userName)
                throws EcmException

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

Parameters:

userName - the name of the user to administrate

Returns:

an administration client for the user with the given name

Throws:

EcmException

search

SearchClient<UserListItemType> search()
                               throws EcmException

This method returns a search client for searching users.

Returns:

a search client for searching users

Throws:

EcmException

searchDeleted

SearchClient<UserListItemType> searchDeleted()
                                      throws Exception

This method returns a search client for searching deleted users.

Returns:

a search client for searching deleted users

Throws:

EcmException

Exception

createUser

UserReferenceType createUser(CreateUserPropertiesType properties)
                      throws EcmException

This method creates a new user with the given properties.

Parameters:

properties - the properties of the user

Returns:

a reference to the user created

Throws:

EcmException

createUser

UserReferenceType createUser(String shortName,
                             String fullName,
                             String password,
                             String description,
                             String emailAddress)
                      throws EcmException

This method creates a new user with the given properties.

Parameters:

shortName - the short name (display name) of the new user

fullName - the full name of the new user

password - the password of the user

description - a description of the new user

emailAddress - the email address of the user

Returns:

a reference to the user created

Throws:

EcmException

createUser

UserReferenceType createUser(String shortName,
                             String password)
                      throws EcmException

This is a shorthand to createUser(CreateUserPropertiesType). It is equivalent to caling createUser(shortName, shortName, password, "", "").

Parameters:

shortName - the short name (display name) of the new user

password - the password of the user

Returns:

a reference to the user created

Throws:

EcmException