com.flexive.shared.interfaces
Interface ConfigurationEngine

All Superinterfaces:
GenericConfigurationEngine
All Known Subinterfaces:
ConfigurationEngineLocal

public interface ConfigurationEngine
extends GenericConfigurationEngine

Wrapper for accessing parameters transparently with their intrinsic scope.

Author:
Daniel Lichtenberger (daniel.lichtenberger@flexive.com), UCS - unique computing solutions gmbh (http://www.ucs.at)

Method Summary
<T extends java.io.Serializable>
void
putInSource(Parameter<T> parameter, java.lang.String key, T value)
          Store the value in the source configuration EJB for the given parameter.
<T extends java.io.Serializable>
void
putInSource(Parameter<T> parameter, T value)
          Store the value in the source configuration EJB for the given parameter.
 
Methods inherited from interface com.flexive.shared.interfaces.GenericConfigurationEngine
get, get, get, getAll, getAll, getAllWithXStream, getKeys, put, put, remove, remove, removeAll, tryGet
 

Method Detail

putInSource

<T extends java.io.Serializable> void putInSource(Parameter<T> parameter,
                                                  java.lang.String key,
                                                  T value)
                 throws FxApplicationException

Store the value in the source configuration EJB for the given parameter. For example, if a parameter in user scope has a division fallback and is not present for the calling user, the division configuration will be updated.

Note that this may require higher privileges than for reading the given parameter, since a fallback configuration (division or global) may be used.

Parameters:
parameter - the parameter to be checked
key - the key to be used
value - the value to be stored
Throws:
FxApplicationException - if the parameter value could not be updated

putInSource

<T extends java.io.Serializable> void putInSource(Parameter<T> parameter,
                                                  T value)
                 throws FxApplicationException

Store the value in the source configuration EJB for the given parameter. For example, if a parameter in user scope has a division fallback and is not present for the calling user, the division configuration will be updated.

Note that this may require higher privileges than for reading the given parameter, since a fallback configuration (division or global) may be used.

Parameters:
parameter - the parameter to be checked
value - the value to be stored
Throws:
FxApplicationException - if the parameter value could not be updated