nextapp.echoservlet
Class VariableData

java.lang.Object
  nextapp.echoservlet.VariableData

All Implemented Interfaces:

java.io.Serializable

public class VariableData

extends java.lang.Object

implements java.io.Serializable

A container of custom data that is inserted into Template documents at the time they are rendered.

See Also:

Serialized Form

Field Summary

static java.lang.String	APPLICATION_URI A constant variable name used for storing an application's URI
static java.lang.String	CLIENT_DETECT_TARGET_FRAME A constant variable name identifying the target frame to which the client detection page should submit.
static java.lang.String	CLIENT_DETECT_URI A constant variable name identifying the URI of the client detection page that should be displayed during the application startup.
static java.lang.String	CLIENT_ERROR_NOT_READY A constant variable name used for storing the message which will be displayed in the event the user initiates an action on the client when it is not ready.
static java.lang.String	SESSION_EXPIRATION_URI A constant variable name used for storing the URI to which an expired session's client browser will be redirected
static java.lang.String	SPLASH_SCREEN_URI A constant variable name identifying the URI of the splash screen that should be displayed during the application startup.
static java.lang.String	STARTUP_DELAY A constant variable name whose content is an integer indicating the number of milliseconds to delay during the application startup.
static java.lang.String	STARTUP_NO_SCRIPT_ERROR_TEXT A constant variable name whose contents will be displayed during the application startup if JavaScript is not enabled.
static java.lang.String	STARTUP_WINDOW_TEXT A constant variable name whose contents will be displayed during the application startup.
static java.lang.String	STARTUP_WINDOW_TITLE A constant variable name whose contents will be displayed during the application startup.

Constructor Summary

VariableData()
Creates a new VariableData object.

Method Summary

java.lang.String	get(java.lang.String key) Returns the dynamic content associated with the given key.
void	set(java.lang.String key, java.lang.String value) Sets the dynamic content associated with the given key.

Methods inherited from class java.lang.Object

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

Field Detail

APPLICATION_URI

public static final java.lang.String APPLICATION_URI

A constant variable name used for storing an application's URI

See Also:

Constant Field Values

STARTUP_WINDOW_TITLE

public static final java.lang.String STARTUP_WINDOW_TITLE

A constant variable name whose contents will be displayed during the application startup.

See Also:

Constant Field Values

STARTUP_WINDOW_TEXT

public static final java.lang.String STARTUP_WINDOW_TEXT

A constant variable name whose contents will be displayed during the application startup.

See Also:

Constant Field Values

STARTUP_DELAY

public static final java.lang.String STARTUP_DELAY

A constant variable name whose content is an integer indicating the number of milliseconds to delay during the application startup.

See Also:

Constant Field Values

STARTUP_NO_SCRIPT_ERROR_TEXT

public static final java.lang.String STARTUP_NO_SCRIPT_ERROR_TEXT

A constant variable name whose contents will be displayed during the application startup if JavaScript is not enabled.

See Also:

Constant Field Values

SPLASH_SCREEN_URI

public static final java.lang.String SPLASH_SCREEN_URI

A constant variable name identifying the URI of the splash screen that should be displayed during the application startup.

See Also:

Constant Field Values

CLIENT_DETECT_URI

public static final java.lang.String CLIENT_DETECT_URI

A constant variable name identifying the URI of the client detection page that should be displayed during the application startup.

See Also:

Constant Field Values

CLIENT_DETECT_TARGET_FRAME

public static final java.lang.String CLIENT_DETECT_TARGET_FRAME

A constant variable name identifying the target frame to which the client detection page should submit.

See Also:

Constant Field Values

SESSION_EXPIRATION_URI

public static final java.lang.String SESSION_EXPIRATION_URI

A constant variable name used for storing the URI to which an expired session's client browser will be redirected

See Also:

Constant Field Values

CLIENT_ERROR_NOT_READY

public static final java.lang.String CLIENT_ERROR_NOT_READY

A constant variable name used for storing the message which will be displayed in the event the user initiates an action on the client when it is not ready.

See Also:

Constant Field Values

Constructor Detail

VariableData

public VariableData()

Creates a new VariableData object.

Method Detail

get

public java.lang.String get(java.lang.String key)

Returns the dynamic content associated with the given key.

Parameters:

key - The key under which the dynamic content is stored.

Returns:

The dynamic content stored under the specified key.

set

public void set(java.lang.String key,
                java.lang.String value)

Sets the dynamic content associated with the given key.

Parameters:

key - The key under which the dynamic content is to be stored.

value - The dynamic content to store.