|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.ibm.wps.portlets.struts.WpsStrutsViewCommand com.ibm.wps.portlets.struts.WpsStrutsViewJspCommand
public class WpsStrutsViewJspCommand
The WpsStrutsViewJspCommand
class is a command-pattern class used to
provide a mechanism to encapsulate the information needed to redisplay a view
for dynamic content like JSPs.
Field Summary | |
---|---|
protected static java.lang.String |
QUERY
Name of the request attribute for the query string. |
protected static java.lang.String |
URI
Name of the request attribute for the URI string. |
Fields inherited from class com.ibm.wps.portlets.struts.WpsStrutsViewCommand |
---|
LAST_MODIFIED, PREFIX |
Constructor Summary | |
---|---|
WpsStrutsViewJspCommand()
Default construtor for WpsStrutsViewJspCommand. |
|
WpsStrutsViewJspCommand(java.lang.String uri,
PortletRequest request)
Constructs the View command. |
Method Summary | |
---|---|
static void |
addAttributeNameToSave(java.lang.String attributeName)
Adds the name of an attribute from the object request that needs to be saved if present for the execution of the IViewCommand in Portal's render phase. |
static void |
addAttributeTypeToSave(java.lang.Class attributeType)
Adds the class type of an attribute from the request that needs to be saved if present for the execution of the IViewCommand in Portal's render phase. |
protected void |
addQueryParameters(java.lang.String query,
PortletRequest request)
Adds the query parameters to the request object. |
void |
execute(PortletRequest request,
PortletResponse response,
ViewCommandExecutionContext executionContext)
Executes the given command given the request and response objects. |
java.lang.String |
getQueryString(PortletRequest request)
Returns the query string. |
java.lang.String |
getUri(PortletRequest request)
Returns the URI. |
protected void |
includeURL(java.lang.String uri,
PortletRequest request,
PortletResponse response,
ViewCommandExecutionContext executionContext)
Includes the URL. |
static void |
removeAttributeNameToSave(java.lang.String attributeName)
Removes the name of an attribute from the list of attribute names to save. |
static void |
removeAttributeTypeToSave(java.lang.Class attributeType)
Removes the class type of the request attribute from the list of attributes to save. |
void |
saveAttributes(HttpServletRequest request,
ViewCommandExecutionContext executionContext)
Saves the attributes related to JSP rendering. |
void |
setQueryString(PortletRequest request,
java.lang.String query)
Sets the query string. |
void |
setUri(PortletRequest request,
java.lang.String uri)
Sets the URI to include. |
Methods inherited from class com.ibm.wps.portlets.struts.WpsStrutsViewCommand |
---|
addAttribute, addParameterNameToSave, execute, getLastModified, getPrefix, getRemoveOnModeChange, getSavedAttributes, getSavedCommand, removeAttribute, removeParameterNameToSave, repopulateRequest, saveAsAttribute, saveAsParameter, saveAttribute, saveAttributes, saveCommand, saveCommand, saveParameter, saveParameters, setLastModified, setPrefix, setRemoveOnModeChange, setSavedAttributes |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
protected static final java.lang.String URI
protected static final java.lang.String QUERY
Constructor Detail |
---|
public WpsStrutsViewJspCommand()
public WpsStrutsViewJspCommand(java.lang.String uri, PortletRequest request)
uri
- the uri path to the JSPrequest
- The request object to save context information fromMethod Detail |
---|
public void execute(PortletRequest request, PortletResponse response, ViewCommandExecutionContext executionContext) throws PortletException
execute
in interface IViewCommand
execute
in class WpsStrutsViewCommand
request
- The request objectresponse
- The response objectexecutionContext
- the execution context object
PortletException
- if the request cannot be fulfilledprotected void includeURL(java.lang.String uri, PortletRequest request, PortletResponse response, ViewCommandExecutionContext executionContext) throws PortletException
uri
- the uri to includerequest
- the request objectresponse
- the reponse objectexecutionContext
- the execution context
PortletException
- if the file cannot be includedprotected void addQueryParameters(java.lang.String query, PortletRequest request)
query
- the query stringrequest
- the request objectpublic void saveAttributes(HttpServletRequest request, ViewCommandExecutionContext executionContext)
saveAttributes
in class WpsStrutsViewCommand
request
- the request objectexecutionContext
- the context objectpublic java.lang.String getQueryString(PortletRequest request)
request
- the portlet request object
public void setQueryString(PortletRequest request, java.lang.String query)
request
- the portlet request objectquery
- the query stringpublic java.lang.String getUri(PortletRequest request)
request
- the portlet request object
public void setUri(PortletRequest request, java.lang.String uri)
request
- the portlet request objecturi
- the uri to includepublic static void addAttributeNameToSave(java.lang.String attributeName)
attributeName
- the name of the attribute to savepublic static void removeAttributeNameToSave(java.lang.String attributeName)
attributeName
- the name of the attribute to removepublic static void addAttributeTypeToSave(java.lang.Class attributeType)
attributeType
- the attribute type to savepublic static void removeAttributeTypeToSave(java.lang.Class attributeType)
attributeType
- the attribute type to remove
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |