Package de.uplanet.lucy.server

Class ContextValue

java.lang.Object

de.uplanet.lucy.server.ContextValue

public final class ContextValue
extends Object

Method Summary

Modifier and Type	Method	Description
static Object	getContextValue(de.uplanet.lucy.server.IProcessingContext p_ctx, String p_strQualifiedName)	Get a context value.
static Object	getContextValueWithFallback(de.uplanet.lucy.server.IProcessingContext p_ctx, String p_strQualifiedName, Object p_fallback)	Get a context value and return a fallback value if the specified property does not exist.
static boolean	isKnownContextName(String p_strQualifiedName)	Syntactically check if the given context name is recognized by the framework.

Methods inherited from class java.lang.Object

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

Method Detail

isKnownContextName

public static boolean isKnownContextName(String p_strQualifiedName)

Syntactically check if the given context name is recognized by the framework.

Parameters:

p_strQualifiedName - A qualified context name.

Returns:

true if the given name is a known context name, or false otherwise.

Throws:

IllegalArgumentException - If the given name is null or empty.

See Also:

VARIABLE_NAMESPACE.URN_REQUEST_PREFIX, VARIABLE_NAMESPACE.URN_SESSION_PREFIX, VARIABLE_NAMESPACE.URN_SHARED_STATE_PREFIX, VARIABLE_NAMESPACE.URN_USER_PREFIX, VARIABLE_NAMESPACE.URN_WORKFLOW_USER_PREFIX, VARIABLE_NAMESPACE.URN_SYSTEM_DATA_GROUP_PREFIX

getContextValue

public static Object getContextValue(de.uplanet.lucy.server.IProcessingContext p_ctx,
                                     String p_strQualifiedName)
                              throws de.uplanet.util.InvalidPropertyException

Get a context value.

Parameters:

p_ctx - The context.

p_strQualifiedName - The fully qualified (URN) name of the value.

Returns:

The value.

Throws:

de.uplanet.util.InvalidPropertyException - If the context does not contain a value with the given qualified name.

See Also:

VARIABLE_NAMESPACE.URN_REQUEST_PREFIX, VARIABLE_NAMESPACE.URN_SESSION_PREFIX, VARIABLE_NAMESPACE.URN_SHARED_STATE_PREFIX, VARIABLE_NAMESPACE.URN_USER_PREFIX, VARIABLE_NAMESPACE.URN_WORKFLOW_USER_PREFIX, VARIABLE_NAMESPACE.URN_SYSTEM_DATA_GROUP_PREFIX

getContextValueWithFallback

public static Object getContextValueWithFallback(de.uplanet.lucy.server.IProcessingContext p_ctx,
                                                 String p_strQualifiedName,
                                                 Object p_fallback)

Get a context value and return a fallback value if the specified property does not exist.

Parameters:

p_ctx - The context.

p_strQualifiedName - The fully qualified (URN) name of the value.

p_fallback - The fallback value.

Returns:

The value.

See Also:

getContextValue(IProcessingContext, String)