com.lexmark.saperion.client.administration

Interface UserClient

All Known Implementing Classes:

UserClientImpl

public interface UserClient

This client provides functionality to administrate a given user.

Author:

jschwarz

Method Summary

Modifier and Type	Method and Description
void	delete() This method deletes the user.
void	deleteExtension() This method deletes the schema-extension properties of the user.
void	expirePassword() This method makes the users password expire.
List<AclReferenceType>	getACLs() This method returns the ACLs currently set on the user.
Map<String,PropertyType>	getExtension() This method returns the schema-extension properties of the user.
Date	getPasswordExpiration() This method gets the date when the users password will expire or null if the password never expires.
UserType	load() This method loads the user entity from the user management system.
void	setExtension(Map<String,PropertyType> extension) This method sets the schema-extension properties of the user.
void	undelete() This method un-deletes the user.
void	update(UserPropertiesType properties) This method updates the referenced user with the given properties.
void	updatePassword(String password) This method updates the password of the user.

Method Detail

delete

void delete()
     throws EcmException

This method deletes the user.

Throws:

EcmException - indicates that a system exception occurred

undelete

void undelete()
       throws EcmException

This method un-deletes the user.

Throws:

EcmException - indicates that a system exception occurred

load

UserType load()
       throws EcmException

This method loads the user entity from the user management system. If the user exists the corresponding user entity is returned. Otherwise an exception is thrown.

Returns:

the referenced user entity

Throws:

EcmException - indicates that a system exception occurred

update

void update(UserPropertiesType properties)
     throws EcmException

This method updates the referenced user with the given properties.

Parameters:

properties - the properties to change

Throws:

EcmException - indicates that a system exception occurred

updatePassword

void updatePassword(String password)
             throws EcmException

This method updates the password of the user.

Parameters:

password - the password of the user

Throws:

EcmException - indicates that a system exception occurred

getPasswordExpiration

Date getPasswordExpiration()
                    throws EcmException

This method gets the date when the users password will expire or null if the password never expires.

Returns:

the date when the users password will expire or null if the password never expires

Throws:

EcmException

expirePassword

void expirePassword()
             throws EcmException

This method makes the users password expire.

Throws:

EcmException

setExtension

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

This method sets the schema-extension properties of the user. 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

getExtension

Map<String,PropertyType> getExtension()
                               throws EcmException

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

Returns:

schema-extension properties of the user

Throws:

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

deleteExtension

void deleteExtension()
              throws EcmException

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

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 user.

Returns:

the ACLs currently set on the user

Throws:

EcmException - when loading the ACLs failed