nl.imsystems.atag.servlet
Class ATagRequest

java.lang.Object
  extended by nl.imsystems.atag.servlet.ATagRequest

public class ATagRequest
extends Object

Constants and methods used for Request parameters and attributes mapping and retrival.

Author:
kayvan


Field Summary
static String ATRIBUTE_ATAG_CONTEXT
          Attribute key used for mapping that ATagContext.
static String ATRIBUTE_COMPONENT_SET
          Attribute key used for mapping a java.util.Set of component ids that have been rendered embedded in a panel.
static String ATRIBUTE_SCHEDULES_MAP
          Attribute key used for mapping a java.util.Map of schedule intervals mapped against the component id, for any component using auto refresh.
static String CONTEXT_PARAM_BIND
          Name of context parameter containing the bind value of the component.
static String CONTEXT_PARAM_ID
          Name of context parameter containing the id of the component.
static String CONTEXT_PARAM_PARAM_NAME
          Name of context parameter containing the paramName of the component.
static String CONTEXT_PARAM_TYPE
          Name of context parameter containing the type of the component.
static String CONTEXT_PARAM_VIEW_URL
          Name of context parameter containing the view url value of the component.
static String PARAM_PREFIX
          Prefix used by ATag parameters when posting requests from the client.
static String REQUEST_PARAM_CONTEXTS
          Full name of the request parameter containing the list of contexts.
static String REQUEST_PARAM_EVENT
          Full name of the request parameter containing the event type value.
static String REQUEST_PARAM_RENDER_EVENT_SRC
          Full name of the request parameter containing a boolean value that determines if the event source component should be refreshed.
 
Constructor Summary
ATagRequest()
           
 
Method Summary
static ATagContext getATagContext(HttpServletRequest request)
          Returns the current ATagContect.
static Set getComponentSet(HttpServletRequest request)
          Returns a Set of component Ids that have been rendered during the scope of a panel.
static Map getSchedulesMap(HttpServletRequest request)
          Returns a Map of schedule info mapped against component id of any components initiating or stopping a schedule during the scope of a request.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

PARAM_PREFIX

public static final String PARAM_PREFIX
Prefix used by ATag parameters when posting requests from the client. All parameters posted by the ATag client begin with this value + colon ':' + param name

See Also:
Constant Field Values

REQUEST_PARAM_CONTEXTS

public static final String REQUEST_PARAM_CONTEXTS
Full name of the request parameter containing the list of contexts.

See Also:
Constant Field Values

REQUEST_PARAM_EVENT

public static final String REQUEST_PARAM_EVENT
Full name of the request parameter containing the event type value. This will be the same as the value in the action that generated the event (i.e. 'change', 'click', etc.)

See Also:
Constant Field Values

REQUEST_PARAM_RENDER_EVENT_SRC

public static final String REQUEST_PARAM_RENDER_EVENT_SRC
Full name of the request parameter containing a boolean value that determines if the event source component should be refreshed.

See Also:
Constant Field Values

CONTEXT_PARAM_ID

public static final String CONTEXT_PARAM_ID
Name of context parameter containing the id of the component.

See Also:
Constant Field Values

CONTEXT_PARAM_PARAM_NAME

public static final String CONTEXT_PARAM_PARAM_NAME
Name of context parameter containing the paramName of the component.

See Also:
Constant Field Values

CONTEXT_PARAM_BIND

public static final String CONTEXT_PARAM_BIND
Name of context parameter containing the bind value of the component.

See Also:
Constant Field Values

CONTEXT_PARAM_VIEW_URL

public static final String CONTEXT_PARAM_VIEW_URL
Name of context parameter containing the view url value of the component.

See Also:
Constant Field Values

CONTEXT_PARAM_TYPE

public static final String CONTEXT_PARAM_TYPE
Name of context parameter containing the type of the component.

See Also:
Constant Field Values

ATRIBUTE_COMPONENT_SET

public static final String ATRIBUTE_COMPONENT_SET
Attribute key used for mapping a java.util.Set of component ids that have been rendered embedded in a panel.

See Also:
Constant Field Values

ATRIBUTE_SCHEDULES_MAP

public static final String ATRIBUTE_SCHEDULES_MAP
Attribute key used for mapping a java.util.Map of schedule intervals mapped against the component id, for any component using auto refresh.

See Also:
Constant Field Values

ATRIBUTE_ATAG_CONTEXT

public static final String ATRIBUTE_ATAG_CONTEXT
Attribute key used for mapping that ATagContext.

See Also:
Constant Field Values
Constructor Detail

ATagRequest

public ATagRequest()
Method Detail

getComponentSet

public static Set getComponentSet(HttpServletRequest request)
Returns a Set of component Ids that have been rendered during the scope of a panel.

Parameters:
request - The current request.
Returns:
Set of component Ids that have been rendered during the scope of a panel.

getSchedulesMap

public static Map getSchedulesMap(HttpServletRequest request)
Returns a Map of schedule info mapped against component id of any components initiating or stopping a schedule during the scope of a request.

Parameters:
request -
Returns:
Map of schedules.

getATagContext

public static ATagContext getATagContext(HttpServletRequest request)
Returns the current ATagContect.

Parameters:
request - The current request
Returns:
Current ATagContect.