|
HATS 7.5.1 Web API ReferencePublicly accessible methods not documented here are for IBM internal use only and may change in a future release of the product. |
||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
public interface IRequest
Class Name: IRequest Provides a generic interface for the implementing request objects.
Class Type: Interface
Base Class: None
Intf Class: None
Description:
| Field Summary | |
|---|---|
static String |
CLASSNAME
The fully-qualified name of this class. |
| Method Summary | |
|---|---|
String |
getApplicationId()
Retrieve the application ID. |
Object |
getAttribute(String key)
Retrieve the specified attribute. |
String |
getCharacterEncoding()
Return the character encoding. |
String |
getContextPath()
Retrieve the context path. |
String |
getHeader(String key)
Retrieve the specified header. |
Enumeration |
getHeaderNames()
Retrieve an Enumeration of the header names. |
Locale |
getLocale()
Retrieve the Locale. |
String |
getParameter(String key)
Retrieve the specified parameter. |
Map |
getParameterMap()
Retrieve the parameter Map. |
Enumeration |
getParameterNames()
Retrieve an Enumeration of the parameter names. |
String[] |
getParameterValues(String key)
Retrieve the specified array containing parameter values. |
String |
getPathInfo()
Retrieve the path information. |
String |
getQueryString()
Retrieve the query string. |
String |
getRemoteAddr()
Retrieve the remote address. |
IRequestDispatcher |
getRequestDispatcher(String key)
Retrieve the specified request dispatcher. |
String |
getRequestedSessionId()
Retrieve the requested session ID. |
String |
getRequestURI()
Retrieve the request URI. |
StringBuffer |
getRequestURL()
Retriee the request URL. |
String |
getServletPath()
Retrieve the servlet path. |
ISession |
getSession()
Retrieve the session. |
ISession |
getSession(boolean create)
Retrieve the specified session. |
ISessionService |
getSessionService()
This method is not implemented and will throw a runtime UnsupportedOperationException if invoked. |
String |
getViewId()
Returns unique ID that identifies the view into the application. |
void |
setAttribute(String attribute,
Object key)
Set the attribute for the key. |
| Field Detail |
|---|
static final String CLASSNAME
| Method Detail |
|---|
String getApplicationId()
IRequest.getApplicationId()Object getAttribute(String key)
key - The key of the attribute being retrieved.
String getCharacterEncoding()
String getContextPath()
String getHeader(String key)
key - The header key.
Enumeration getHeaderNames()
Enumeration of the header names.
Enumeration of the header names.Locale getLocale()
Locale.
Locale.String getParameter(String key)
key - The key for the parameter being retrieved.
Map getParameterMap()
Map.
Map.Enumeration getParameterNames()
Enumeration of the parameter names.
Enumeration of the parameter names.String[] getParameterValues(String key)
key - The key for the array being retrieved.
String getPathInfo()
HttpServletRequest.getPathInfo()String getQueryString()
String getRemoteAddr()
IRequestDispatcher getRequestDispatcher(String key)
key - The key for the requested dispatcher.
String getRequestedSessionId()
String getRequestURI()
StringBuffer getRequestURL()
String getServletPath()
ISession getSession()
ISession getSession(boolean create)
create - Indicating if a new session should be created.
ISessionService getSessionService()
String getViewId()
void setAttribute(String attribute,
Object key)
attribute - The attribute to be set.key - The key used to save the attribute.
|
HATS 7.5.1 (201005110649) | ||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||