org.apache.tapestry.services
Class ServiceConstants

java.lang.Object
  org.apache.tapestry.services.ServiceConstants

public class ServiceConstants
extends Object

Defines constants for query parameters names commonly used by services.

Since:

4.0

Author:

Howard M. Lewis Ship

Field Summary

static String	COMPONENT The id path to the component within the page.
static String	CONTAINER The name of the page containing the component; this is only specified when the component is contained by a page other than the activate page (PAGE).
static String	PAGE The name of the page to activate when processing the service.
static String	PARAMETER Contains a number of additional strings meaningful to the application (the term service parameters is something of an entrenched misnomer, a better term would have been application parameters).
static String[]	RESERVED_IDS A list of all the constants defined by this class.
static String	SERVICE The name of the service responsible for processing the request.
static String	SESSION A flag indicating whether a session was active when the link was rendered.
static String	UPDATE_PARTS Contains a string list of the parts in a response that should be updated.

Constructor Summary

ServiceConstants()

Method Summary

Methods inherited from class java.lang.Object

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

Field Detail

SERVICE

public static final String SERVICE

The name of the service responsible for processing the request.

See Also:

Constant Field Values

PAGE

public static final String PAGE

The name of the page to activate when processing the service.

See Also:

Constant Field Values

COMPONENT

public static final String COMPONENT

The id path to the component within the page. By convention, this component is within the PAGE.

See Also:

Constant Field Values

CONTAINER

public static final String CONTAINER

The name of the page containing the component; this is only specified when the component is contained by a page other than the activate page (PAGE).

See Also:

Constant Field Values

SESSION

public static final String SESSION

A flag indicating whether a session was active when the link was rendered. If this is true, but no session is active when the request is processed, the a service may at its discression throw a StaleLinkException

See Also:

Constant Field Values

PARAMETER

public static final String PARAMETER

Contains a number of additional strings meaningful to the application (the term service parameters is something of an entrenched misnomer, a better term would have been application parameters). These parameters are typically objects that have been squeezed into strings by DataSqueezer.

The value is currently "sp" for vaguely historical reasons ("service parameter"), though it would be better if it were "lp" (for "listener parameter"), or just "param" perhaps.

See Also:

Constant Field Values

UPDATE_PARTS

public static final String UPDATE_PARTS

Contains a string list of the parts in a response that should be updated. Parts can be both components and normal html tags resolved via their unique id's.

See Also:

Constant Field Values

RESERVED_IDS

public static final String[] RESERVED_IDS

A list of all the constants defined by this class.

See Also:

FormSupportImpl

Constructor Detail

ServiceConstants

public ServiceConstants()