cz.ues.platform.uwt

Interface UWTContext

public interface UWTContext

The context for visual components. The context is typically obtained using UWTContextFactory:

UWTContextFactory ctxFactory = UESComponentFactory.getComponent(UWTContextFactory.class);
UWTContext ctx = ctxFactory.getCurrentContext();

Since:

UES7-06

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	SCOPE_HTTP_REQUEST The scope with time validity of a HTTP request.
static java.lang.String	SCOPE_HTTP_SESSION The scope with time validity of a HTTP session.
static java.lang.String	SCOPE_PERSIST The scope with unlimited time validity (data doesn't expire in this scope).

Method Summary

Methods

Modifier and Type	Method and Description
<T> T	getAttribute(java.lang.String aCode, java.lang.Class<T> aClass) Returns the attribute with given code.
<T> T	getAttribute(UWTContextAttributeKey aKey, java.lang.Class<T> aClass) Returns the attribute with given key.
javax.servlet.http.HttpServletRequest	getRequest() Returns the request associated with this context.
javax.servlet.http.HttpServletResponse	getResponse() Returns the response associated with this context.
UCDescriptor	getUCDescriptor() Returns the descriptor of the currently running use case.
void	setAttribute(java.lang.String aCode, java.lang.Object aValue, java.lang.String aScope) Sets the attribute with given code to contain the value aValue into given scope.
void	setAttribute(UWTContextAttributeKey aKey, java.lang.Object aValue, java.lang.String aScope) Sets the attribute with given code to contain the value aValue into given scope.

Field Detail

SCOPE_HTTP_REQUEST

static final SCOPE_HTTP_REQUEST

The scope with time validity of a HTTP request.

See Also:

Constant Field Values

SCOPE_HTTP_SESSION

static final SCOPE_HTTP_SESSION

The scope with time validity of a HTTP session.

See Also:

Constant Field Values

SCOPE_PERSIST

static final SCOPE_PERSIST

The scope with unlimited time validity (data doesn't expire in this scope).

See Also:

Constant Field Values

Method Detail

getAttribute

<T> T getAttribute(java.lang.String aCode,
java.lang.Class<T> aClass)

Returns the attribute with given code. Default owner and default UC code are used when getting the attribute.

Type Parameters:

T - The type of the value.

Parameters:

aCode - The code identifying an attribute as per visual component instance.

aClass - The class of the value.

Returns:

The value of the attribute or null, if no such attribute exists.

Since:

UES7-06

setAttribute

void setAttribute(java.lang.String aCode,
java.lang.Object aValue,
java.lang.String aScope)

Sets the attribute with given code to contain the value aValue into given scope. Default owner and default UC code are used when setting the attribute.

Parameters:

aCode - The code identifying an attribute as per visual component instance.

aValue - The value to set.

aScope - The scope to set the value to. Usually one of UWTContext.SCOPE_* constants.

Since:

UES7-06

getAttribute

<T> T getAttribute(UWTContextAttributeKey aKey,
java.lang.Class<T> aClass)

Returns the attribute with given key. If the key doesn't contain an owner or a UC code, default value will be used for the respective field.

Type Parameters:

T - The type of the value.

Parameters:

aKey - The attribute key.

aClass - The class of the value.

Returns:

The value of the attribute or null, if no such attribute exists.

Since:

UES7-06

setAttribute

void setAttribute(UWTContextAttributeKey aKey,
java.lang.Object aValue,
java.lang.String aScope)

Sets the attribute with given code to contain the value aValue into given scope. If the key doesn't contain an owner or a UC code, default value will be used for the respective field.

Parameters:

aKey - The key of the attribute.

aValue - The value to set.

aScope - The scope to set the value to. Usually one of UWTContext.SCOPE_* constants.

Since:

UES7-06

getRequest

javax.servlet.http.HttpServletRequest getRequest()

Returns the request associated with this context.

Returns:

The request associated with this context.

Since:

UES7-06

getResponse

javax.servlet.http.HttpServletResponse getResponse()

Returns the response associated with this context.

Returns:

The response associated with this context.

Since:

UES7-06

getUCDescriptor

UCDescriptor getUCDescriptor()

Returns the descriptor of the currently running use case.

Returns:

The descriptor of the currently running use case.

Since:

UES7-08