com.sap.caf.eu.gp.context.api

Interface IGPInvocationContext

public interface IGPInvocationContext

The invocation context holds context information about certain call and also provides a possibility for applications to store internal not user related parameters.

Method Summary

String	getParameterValue(String application, String parameterName) Return parameter value in cache or on database.
String	removeParameterValue(String application, String parameterName) Remove parameter value from cache.
void	setParameterValue(String application, String parameterName, String parameterValue) Add parameter value to cache.

Method Detail

getParameterValue

public String getParameterValue(String application,
                                String parameterName)
                         throws GPEngineException,
                                GPInvocationException

Return parameter value in cache or on database.

If parameter value is not in cache already it is added.

Parameters:

application - application key

parameterName - name of the configuration parameter

Returns:

value of the configuration parameter (may be null)

Throws:

GPEngineException

GPInvocationException

setParameterValue

public void setParameterValue(String application,
                              String parameterName,
                              String parameterValue)
                       throws GPEngineException,
                              GPInvocationException

Add parameter value to cache.

Parameters:

application - application key

parameterName - name of the configuration parameter

parameterValue - value of the configuration parameter

Returns:

value of the configuration parameter (may be null)

Throws:

GPEngineException

GPInvocationException

removeParameterValue

public String removeParameterValue(String application,
                                   String parameterName)
                            throws GPEngineException,
                                   GPInvocationException

Remove parameter value from cache.

Parameters:

application - application key

parameterName - name of the configuration parameter

Returns:

value of the configuration parameter (may be null)

Throws:

GPEngineException

GPInvocationException