com.kheops.jmap.client

Class JMapUserParameterController

java.lang.Object

com.kheops.jmap.client.JMapUserParameterController

public class JMapUserParameterController
extends java.lang.Object

This class is used to register, save and load user parameters from JMap Server.

Constructor Summary

Constructors

Constructor and Description
JMapUserParameterController(JMapApplicationContext appContext)

Method Summary

Modifier and Type	Method and Description
void	addControllerListener(UserParameterControllerListener listener) Adds a new user parameter controller listener in the controller.
void	addListener(UserParameterListener listener) Adds a new user parameter listener in the controller.
void	destroy() Destroy method called by JMapApplication.
UserParameter	getUserParameter(java.lang.String parameterKey) Returns the user parameter that was set for the specified parameter key.
void	load() Loads all user parameters from JMap Server and dispatches them to the listeners.
void	removeControllerListener(UserParameterControllerListener listener) Removes a user parameter controller listener from the controller.
void	removeListener(UserParameterListener listener) Removes a user parameter listener from the controller.
void	save() Saves all user parameters defined in listeners and from the main database to the server.
void	setUserParameter(UserParameter userParameter) Sets a parameter for the current user.

Methods inherited from class java.lang.Object

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

Constructor Detail

JMapUserParameterController

public JMapUserParameterController(JMapApplicationContext appContext)

Method Detail

addListener

public void addListener(UserParameterListener listener)

Adds a new user parameter listener in the controller.

Parameters:

listener - the listener to be added.

removeListener

public void removeListener(UserParameterListener listener)

Removes a user parameter listener from the controller.

Parameters:

listener - the listener to be removed.

addControllerListener

public void addControllerListener(UserParameterControllerListener listener)

Adds a new user parameter controller listener in the controller.

Parameters:

listener - the listener to be added.

removeControllerListener

public void removeControllerListener(UserParameterControllerListener listener)

Removes a user parameter controller listener from the controller.

Parameters:

listener - the listener to be removed.

save

public void save()

Saves all user parameters defined in listeners and from the main database to the server.

load

public void load()

Loads all user parameters from JMap Server and dispatches them to the listeners.

getUserParameter

public UserParameter getUserParameter(java.lang.String parameterKey)

Returns the user parameter that was set for the specified parameter key.

Parameters:

parameterKey - the parameter key used to retrieve the user parameter.

Returns:

the user parameter defined for the specified parameter key, or null if not defined.

setUserParameter

public void setUserParameter(UserParameter userParameter)

Sets a parameter for the current user.

Parameters:

userParameter - the user parameter to set.

destroy

public void destroy()

Destroy method called by JMapApplication.