PagerWebConst (axelframework 3.1.12.RELEASE API)

java.lang.Object
- org.xmlactions.web.PagerWebConst

public class PagerWebConst
extends java.lang.Object

Field Summary

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`EXEC_CONTEXT` If we want to retrieve the execContext from the execContext using ${execContext}
`static java.lang.String`	`HTTP_REQUEST` HttpRequest is stored in execContext as a HttpRequest using this identifying string.
`static java.lang.String`	`HTTP_RESPONSE` HttpResponse is stored in execContext as a HttpResponse using this identifying string.
`static java.lang.String`	`HTTP_SESSION` HttpSession is stored in execContext as a HttpSession using this identifying string.
`static java.lang.String`	`NO_STR_SUBST` If this is set than the pager won't perform a StrSubstution on the page before returing it to the browser.
`static java.lang.String`	`PAGE_APP_NAME` Gets the current page application name from the execContext.
`static java.lang.String`	`PAGE_NAME` Gets the current page name from the execContext.
`static java.lang.String`	`PAGE_SERVER_NAME` Gets the current page server name from the execContext.
`static java.lang.String`	`PAGE_URI` Gets the current page uri from the execContext.
`static java.lang.String`	`PAGE_URL` Gets the current page url from the execContext.
`static java.lang.String`	`REQUEST` HttpRequest parameters are stored in execContext as a Named Map using this identifying string.
`static java.lang.String`	`REQUEST_HEADERS` HttpRequest parameters are stored in execContext as an ArrayList using this identifying string.
`static java.lang.String`	`REQUEST_LIST` HttpRequest parameters are stored in execContext as an ArrayList using this identifying string.

Constructor Summary

Constructors
Constructor and Description

PagerWebConst()

Constructors
Constructor and Description
`PagerWebConst()`

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static java.lang.String`	`buildRequestKey(java.lang.String key)` Builds the key prepending the HttpRequest named map name in the execContext.
`static java.lang.String`	`getPageName(IExecContext execContext)` Gets the current httpRequest page.
`static java.lang.String`	`getPageURI(IExecContext execContext)` Gets the current httpRequest page uri.
`static java.lang.String`	`getPageURL(IExecContext execContext)` Gets the current httpRequest page url.
`static java.lang.String`	`getRequestParameter(IExecContext execContext, java.lang.String key)` Gets a value from the HttpRequest params contained within the map.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - EXEC_CONTEXT
```
public static final java.lang.String EXEC_CONTEXT
```
    If we want to retrieve the execContext from the execContext using ${execContext}
    
    See Also:
    
    Constant Field Values
  - REQUEST
```
public static final java.lang.String REQUEST
```
    HttpRequest parameters are stored in execContext as a Named Map using this identifying string.
    
    See Also:
    
    Constant Field Values
  - REQUEST_LIST
```
public static final java.lang.String REQUEST_LIST
```
    HttpRequest parameters are stored in execContext as an ArrayList using this identifying string.
    
    See Also:
    
    Constant Field Values
  - REQUEST_HEADERS
```
public static final java.lang.String REQUEST_HEADERS
```
    HttpRequest parameters are stored in execContext as an ArrayList using this identifying string.
    
    See Also:
    
    Constant Field Values
  - HTTP_REQUEST
```
public static final java.lang.String HTTP_REQUEST
```
    HttpRequest is stored in execContext as a HttpRequest using this identifying string.
    
    See Also:
    
    Constant Field Values
  - HTTP_RESPONSE
```
public static final java.lang.String HTTP_RESPONSE
```
    HttpResponse is stored in execContext as a HttpResponse using this identifying string.
    
    See Also:
    
    Constant Field Values
  - HTTP_SESSION
```
public static final java.lang.String HTTP_SESSION
```
    HttpSession is stored in execContext as a HttpSession using this identifying string.
    
    See Also:
    
    Constant Field Values
  - PAGE_NAME
```
public static final java.lang.String PAGE_NAME
```
    Gets the current page name from the execContext. This gets stored from the PagerServlet when it gets the page name from the http request.
    
    See Also:
    
    Constant Field Values
  - PAGE_URI
```
public static final java.lang.String PAGE_URI
```
    Gets the current page uri from the execContext. This gets stored from the PagerServlet when it gets the page uri from the http request.
    
    See Also:
    
    Constant Field Values
  - PAGE_URL
```
public static final java.lang.String PAGE_URL
```
    Gets the current page url from the execContext. This gets stored from the PagerServlet when it gets the page url from the http request.
    
    See Also:
    
    Constant Field Values
  - PAGE_SERVER_NAME
```
public static final java.lang.String PAGE_SERVER_NAME
```
    Gets the current page server name from the execContext. This gets stored from the PagerServlet when it gets the page url from the http request.
    
    See Also:
    
    Constant Field Values
  - PAGE_APP_NAME
```
public static final java.lang.String PAGE_APP_NAME
```
    Gets the current page application name from the execContext. This gets stored from the PagerServlet when it gets the page url from the http request.
    
    See Also:
    
    Constant Field Values
  - NO_STR_SUBST
```
public static final java.lang.String NO_STR_SUBST
```
    If this is set than the pager won't perform a StrSubstution on the page before returing it to the browser.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - PagerWebConst
```
public PagerWebConst()
```
- Method Detail
  - getRequestParameter
```
public static java.lang.String getRequestParameter(IExecContext execContext,
                                                   java.lang.String key)
```
    Gets a value from the HttpRequest params contained within the map.
    
    Parameters:
    
    execContext - containing the HttpRequest parameters
    
    key - the key to the parameter
    
    Returns:
    
    the value or null if not found
  - buildRequestKey
```
public static java.lang.String buildRequestKey(java.lang.String key)
```
    Builds the key prepending the HttpRequest named map name in the execContext.
    
    Parameters:
    
    key - the key name for the HttpRequest parameter
    
    Returns:
    
    the full key name that includes the HttpRequest named map.
  - getPageName
```
public static java.lang.String getPageName(IExecContext execContext)
```
    Gets the current httpRequest page.
    
    Parameters:
    
    execContext -
    
    Returns:
    
    the name of the httpRequest page.
  - getPageURI
```
public static java.lang.String getPageURI(IExecContext execContext)
```
    Gets the current httpRequest page uri.
    
    Parameters:
    
    execContext -
    
    Returns:
    
    the name of the httpRequest page uri.
  - getPageURL
```
public static java.lang.String getPageURL(IExecContext execContext)
```
    Gets the current httpRequest page url.
    
    Parameters:
    
    execContext -
    
    Returns:
    
    the name of the httpRequest page url.

Class PagerWebConst

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

EXEC_CONTEXT

REQUEST

REQUEST_LIST

REQUEST_HEADERS

HTTP_REQUEST

HTTP_RESPONSE

HTTP_SESSION

PAGE_NAME

PAGE_URI

PAGE_URL

PAGE_SERVER_NAME

PAGE_APP_NAME

NO_STR_SUBST

Constructor Detail

PagerWebConst

Method Detail

getRequestParameter

buildRequestKey

getPageName

getPageURI

getPageURL