lumis.portal
Class PortalRequestParameters

Package class diagram package PortalRequestParameters
java.lang.Object
  extended by lumis.portal.PortalRequestParameters

public class PortalRequestParameters
extends Object

Object representing portal parameters

Since:
4.0.0

Nested Class Summary
static class PortalRequestParameters.PreviousParameters
          The previous parameters of a page.
 
Field Summary
static String II_PARAMETER_PORTLET_MODE
          Parameter at service interface instance scope that stores the portlet mode.
static String II_PARAMETER_WINDOW_STATE
          Parameter at service interface instance scope that stores the window state.
static String PAGE_PARAMETER_CALLER_INTERFACE_INST
           
static String PAGE_PARAMETER_CHANNELID
           
static String PAGE_PARAMETER_CLIENT_SCRIPT_REQUEST
           
static String PAGE_PARAMETER_CLIENTRENDERED
           
static String PAGE_PARAMETER_DATA_PREVIEW_MODE
           
static String PAGE_PARAMETER_FROM_PCM
           
static String PAGE_PARAMETER_HIGHLIGHT_INTERFACE_INST
           
static String PAGE_PARAMETER_INTERFACE
           
static String PAGE_PARAMETER_INTERFACE_INST
           
static String PAGE_PARAMETER_ITEMID
           
static String PAGE_PARAMETER_LOCAL_MODE
           
static String PAGE_PARAMETER_LOCALE
           
static String PAGE_PARAMETER_NEW
           
static String PAGE_PARAMETER_PAGE_CACHE_ID
           
static String PAGE_PARAMETER_PAGE_CACHE_TYPE
           
static String PAGE_PARAMETER_PAGEID
           
static String PAGE_PARAMETER_PREVIEW_ITEMID
           
static String PAGE_PARAMETER_PREVIOUS
           
static String PAGE_PARAMETER_PREVIOUS_STORAGE_ID
          Stores the id that identifies the previous parameter in the session object.
static String PAGE_PARAMETER_PRINTING
           
static String PAGE_PARAMETER_PROCESS_ACTION
           
static String PAGE_PARAMETER_RENDER_INTERFACE_INST
           
static String PAGE_PARAMETER_REQUEST_FROM_HTML_FILE
           
static String PAGE_PARAMETER_RUN_TIME_INTERFACE
           
static String PAGE_PARAMETER_RUN_TIME_SERVICE_INST
           
static String PAGE_PARAMETER_SAVE_XML
           
static String PAGE_PARAMETER_SERVICE
           
static String PAGE_PARAMETER_SERVICE_INST
           
static String URL_REPLACEABLE_PARAMETER_PAGEID
           
 
Constructor Summary
PortalRequestParameters(SessionConfig sessionConfig, HttpServletRequest httpServletRequest, ITransaction portalTransaction)
           
PortalRequestParameters(SessionConfig sessionConfig, ITransaction portalTransaction)
           
PortalRequestParameters(SessionConfig sessionConfig, String parametersXmlString, ITransaction portalTransaction)
           
 
Method Summary
 PortalRequestParameters.PreviousParameters generatePreviousParameters(HttpServletRequest request)
          Generate the previous parameters for this portal request parameters instance, storing it for automatic later retrival.
 String getPageParameterValue(String name)
           
 String getPreviousParametersStorageId()
          Returns the previous parameters storage id.
 FileParameter getServiceInterfaceInstanceFileParameterValue(String name, String serviceInterfaceInstanceId)
           
 Enumeration<String> getServiceInterfaceInstanceParameterNames(String serviceInterfaceInstanceId)
           
 Map<String,String[]> getServiceInterfaceInstanceParameters(String serviceInterfaceInstanceId)
           
 String getServiceInterfaceInstanceParameterValue(String name, String serviceInterfaceInstanceId)
           
 String[] getServiceInterfaceInstanceParameterValues(String name, String serviceInterfaceInstanceId)
           
static boolean isReservedParameter(String parameterName)
          Indicates if the parameter is reserved for special use by the portal and may not be freely used by an installed application.
 void setPageParameter(String parameterName, String[] parameterValues)
           
 void setPageParameters(Map<String,String[]> parameters)
           
 HashMap<String,String[]> setParameters(Document parametersDoc)
           
 void setParameters(String parametersXmlString)
           
 void setServiceInstanceParameters(String serviceInstanceId, Map<String,String[]> parameters)
           
 void setServiceInterfaceInstanceFileParameters(String serviceInterfaceInstanceId, Map<String,FileParameter> parameters)
           
 void setServiceInterfaceInstanceParameters(String serviceInterfaceInstanceId, Map<String,String[]> parameters)
           
 void setServiceInterfaceParameters(String serviceInterfaceId, Map<String,String[]> parameters)
           
 void setServiceParameters(String serviceId, Map<String,String[]> parameters)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

PAGE_PARAMETER_CLIENT_SCRIPT_REQUEST

public static final String PAGE_PARAMETER_CLIENT_SCRIPT_REQUEST
See Also:
Constant Field Values

PAGE_PARAMETER_PRINTING

public static final String PAGE_PARAMETER_PRINTING
See Also:
Constant Field Values

PAGE_PARAMETER_FROM_PCM

public static final String PAGE_PARAMETER_FROM_PCM
See Also:
Constant Field Values

PAGE_PARAMETER_SAVE_XML

public static final String PAGE_PARAMETER_SAVE_XML
See Also:
Constant Field Values

PAGE_PARAMETER_RENDER_INTERFACE_INST

public static final String PAGE_PARAMETER_RENDER_INTERFACE_INST
See Also:
Constant Field Values

PAGE_PARAMETER_CALLER_INTERFACE_INST

public static final String PAGE_PARAMETER_CALLER_INTERFACE_INST
See Also:
Constant Field Values

PAGE_PARAMETER_PREVIEW_ITEMID

public static final String PAGE_PARAMETER_PREVIEW_ITEMID
See Also:
Constant Field Values

PAGE_PARAMETER_DATA_PREVIEW_MODE

public static final String PAGE_PARAMETER_DATA_PREVIEW_MODE
See Also:
Constant Field Values

PAGE_PARAMETER_ITEMID

public static final String PAGE_PARAMETER_ITEMID
See Also:
Constant Field Values

PAGE_PARAMETER_RUN_TIME_INTERFACE

public static final String PAGE_PARAMETER_RUN_TIME_INTERFACE
See Also:
Constant Field Values

PAGE_PARAMETER_RUN_TIME_SERVICE_INST

public static final String PAGE_PARAMETER_RUN_TIME_SERVICE_INST
See Also:
Constant Field Values

PAGE_PARAMETER_SERVICE_INST

public static final String PAGE_PARAMETER_SERVICE_INST
See Also:
Constant Field Values

PAGE_PARAMETER_SERVICE

public static final String PAGE_PARAMETER_SERVICE
See Also:
Constant Field Values

PAGE_PARAMETER_INTERFACE

public static final String PAGE_PARAMETER_INTERFACE
See Also:
Constant Field Values

PAGE_PARAMETER_INTERFACE_INST

public static final String PAGE_PARAMETER_INTERFACE_INST
See Also:
Constant Field Values

PAGE_PARAMETER_NEW

public static final String PAGE_PARAMETER_NEW
See Also:
Constant Field Values

PAGE_PARAMETER_PREVIOUS

public static final String PAGE_PARAMETER_PREVIOUS
See Also:
Constant Field Values

PAGE_PARAMETER_PROCESS_ACTION

public static final String PAGE_PARAMETER_PROCESS_ACTION
See Also:
Constant Field Values

PAGE_PARAMETER_PAGEID

public static final String PAGE_PARAMETER_PAGEID
See Also:
Constant Field Values

PAGE_PARAMETER_CHANNELID

public static final String PAGE_PARAMETER_CHANNELID
See Also:
Constant Field Values

PAGE_PARAMETER_CLIENTRENDERED

public static final String PAGE_PARAMETER_CLIENTRENDERED
See Also:
Constant Field Values

PAGE_PARAMETER_REQUEST_FROM_HTML_FILE

public static final String PAGE_PARAMETER_REQUEST_FROM_HTML_FILE
See Also:
Constant Field Values

PAGE_PARAMETER_PAGE_CACHE_ID

public static final String PAGE_PARAMETER_PAGE_CACHE_ID
See Also:
Constant Field Values

PAGE_PARAMETER_PAGE_CACHE_TYPE

public static final String PAGE_PARAMETER_PAGE_CACHE_TYPE
See Also:
Constant Field Values

PAGE_PARAMETER_LOCALE

public static final String PAGE_PARAMETER_LOCALE
See Also:
Constant Field Values

PAGE_PARAMETER_LOCAL_MODE

public static final String PAGE_PARAMETER_LOCAL_MODE
See Also:
Constant Field Values

PAGE_PARAMETER_HIGHLIGHT_INTERFACE_INST

public static final String PAGE_PARAMETER_HIGHLIGHT_INTERFACE_INST
See Also:
Constant Field Values

URL_REPLACEABLE_PARAMETER_PAGEID

public static final String URL_REPLACEABLE_PARAMETER_PAGEID
See Also:
Constant Field Values

PAGE_PARAMETER_PREVIOUS_STORAGE_ID

public static final String PAGE_PARAMETER_PREVIOUS_STORAGE_ID
Stores the id that identifies the previous parameter in the session object.

Since:
4.0.7
See Also:
PreviousParametersStorage, Constant Field Values

II_PARAMETER_PORTLET_MODE

public static final String II_PARAMETER_PORTLET_MODE
Parameter at service interface instance scope that stores the portlet mode.

Since:
4.0.7
See Also:
Constant Field Values

II_PARAMETER_WINDOW_STATE

public static final String II_PARAMETER_WINDOW_STATE
Parameter at service interface instance scope that stores the window state.

Since:
4.0.7
See Also:
Constant Field Values
Constructor Detail

PortalRequestParameters

public PortalRequestParameters(SessionConfig sessionConfig,
                               ITransaction portalTransaction)

PortalRequestParameters

public PortalRequestParameters(SessionConfig sessionConfig,
                               String parametersXmlString,
                               ITransaction portalTransaction)
                        throws PortalException
Throws:
PortalException

PortalRequestParameters

public PortalRequestParameters(SessionConfig sessionConfig,
                               HttpServletRequest httpServletRequest,
                               ITransaction portalTransaction)
                        throws PortalException
Throws:
PortalException
Method Detail

isReservedParameter

public static boolean isReservedParameter(String parameterName)
Indicates if the parameter is reserved for special use by the portal and may not be freely used by an installed application.

Parameters:
parameterName - the parameter name.
Returns:
true if the parameter is reserved, false otherwise.
Since:
4.0.7

setParameters

public void setParameters(String parametersXmlString)
                   throws PortalException
Throws:
PortalException

setParameters

public HashMap<String,String[]> setParameters(Document parametersDoc)
                                       throws PortalException
Throws:
PortalException

getServiceInterfaceInstanceParameterNames

public Enumeration<String> getServiceInterfaceInstanceParameterNames(String serviceInterfaceInstanceId)
                                                              throws PortalException
Throws:
PortalException

getServiceInterfaceInstanceFileParameterValue

public FileParameter getServiceInterfaceInstanceFileParameterValue(String name,
                                                                   String serviceInterfaceInstanceId)

getServiceInterfaceInstanceParameterValue

public String getServiceInterfaceInstanceParameterValue(String name,
                                                        String serviceInterfaceInstanceId)
                                                 throws PortalException
Throws:
PortalException

getServiceInterfaceInstanceParameterValues

public String[] getServiceInterfaceInstanceParameterValues(String name,
                                                           String serviceInterfaceInstanceId)
                                                    throws PortalException
Throws:
PortalException

getServiceInterfaceInstanceParameters

public Map<String,String[]> getServiceInterfaceInstanceParameters(String serviceInterfaceInstanceId)
                                                           throws PortalException
Throws:
PortalException

setServiceInterfaceInstanceParameters

public void setServiceInterfaceInstanceParameters(String serviceInterfaceInstanceId,
                                                  Map<String,String[]> parameters)
                                           throws PortalException
Throws:
PortalException

setServiceInterfaceInstanceFileParameters

public void setServiceInterfaceInstanceFileParameters(String serviceInterfaceInstanceId,
                                                      Map<String,FileParameter> parameters)
                                               throws PortalException
Throws:
PortalException

setServiceInterfaceParameters

public void setServiceInterfaceParameters(String serviceInterfaceId,
                                          Map<String,String[]> parameters)
                                   throws PortalException
Throws:
PortalException

setServiceInstanceParameters

public void setServiceInstanceParameters(String serviceInstanceId,
                                         Map<String,String[]> parameters)
                                  throws PortalException
Throws:
PortalException

setServiceParameters

public void setServiceParameters(String serviceId,
                                 Map<String,String[]> parameters)
                          throws PortalException
Throws:
PortalException

setPageParameters

public void setPageParameters(Map<String,String[]> parameters)
                       throws PortalException
Throws:
PortalException

setPageParameter

public void setPageParameter(String parameterName,
                             String[] parameterValues)
                      throws PortalException
Throws:
PortalException

getPreviousParametersStorageId

public final String getPreviousParametersStorageId()
Returns the previous parameters storage id. This value is to be used as the value for the PAGE_PARAMETER_PREVIOUS_STORAGE_ID parameter when the session storage is to be used if the previous parameters in the requeest are not found.

Returns:
the previous parameters storage id.
Since:
4.0.7

generatePreviousParameters

public PortalRequestParameters.PreviousParameters generatePreviousParameters(HttpServletRequest request)
                                                                      throws PortalException
Generate the previous parameters for this portal request parameters instance, storing it for automatic later retrival. For the automatic later retrival, the parameter PAGE_PARAMETER_PREVIOUS_STORAGE_ID must be set with the value of the key of the previous parameters returned.

Parameters:
request - the user's request.
Returns:
the previous parameters information.
Throws:
PortalException
Since:
4.0.7

getPageParameterValue

public String getPageParameterValue(String name)
                             throws PortalException
Throws:
PortalException


Lumisportal  4.1.0.071221 - Copyright © 2001-2007, Lumis. All Rights Reserved.