Package lumis.portal

Class PortalRequestParameters

  • public class PortalRequestParameters
extends java.lang.Object
    Object representing portal parameters.
    Since:
    4.0.0
    Version:
    $Revision$ $Date$

    • Field Detail

      • PAGE_PARAMETER_CLIENT_SCRIPT_REQUEST

        public static final java.lang.String PAGE_PARAMETER_CLIENT_SCRIPT_REQUEST
        See Also:
        Constant Field Values

      • PAGE_PARAMETER_PRINTING

        public static final java.lang.String PAGE_PARAMETER_PRINTING
        See Also:
        Constant Field Values

      • PAGE_PARAMETER_FROM_PCM

        public static final java.lang.String PAGE_PARAMETER_FROM_PCM
        See Also:
        Constant Field Values

      • PAGE_PARAMETER_SAVE_XML

        public static final java.lang.String PAGE_PARAMETER_SAVE_XML
        See Also:
        Constant Field Values

      • PAGE_PARAMETER_RENDER_INTERFACE_INST

        public static final java.lang.String PAGE_PARAMETER_RENDER_INTERFACE_INST
        See Also:
        Constant Field Values

      • PAGE_PARAMETER_CALLER_INTERFACE_INST

        public static final java.lang.String PAGE_PARAMETER_CALLER_INTERFACE_INST
        See Also:
        Constant Field Values

      • PAGE_PARAMETER_PREVIEW_ITEMID

        public static final java.lang.String PAGE_PARAMETER_PREVIEW_ITEMID
        See Also:
        Constant Field Values

      • PAGE_PARAMETER_DATA_PREVIEW_MODE

        public static final java.lang.String PAGE_PARAMETER_DATA_PREVIEW_MODE
        See Also:
        Constant Field Values

      • PAGE_PARAMETER_ITEMID

        public static final java.lang.String PAGE_PARAMETER_ITEMID
        See Also:
        Constant Field Values

      • PAGE_PARAMETER_ITEM_ID

        public static final java.lang.String PAGE_PARAMETER_ITEM_ID
        See Also:
        Constant Field Values

      • PAGE_PARAMETER_RUN_TIME_INTERFACE

        public static final java.lang.String PAGE_PARAMETER_RUN_TIME_INTERFACE
        See Also:
        Constant Field Values

      • PAGE_PARAMETER_RUN_TIME_SERVICE_INST

        public static final java.lang.String PAGE_PARAMETER_RUN_TIME_SERVICE_INST
        See Also:
        Constant Field Values

      • PAGE_PARAMETER_SERVICE_INST

        public static final java.lang.String PAGE_PARAMETER_SERVICE_INST
        See Also:
        Constant Field Values

      • PAGE_PARAMETER_SERVICE

        public static final java.lang.String PAGE_PARAMETER_SERVICE
        See Also:
        Constant Field Values

      • PAGE_PARAMETER_INTERFACE

        public static final java.lang.String PAGE_PARAMETER_INTERFACE
        See Also:
        Constant Field Values

      • PAGE_PARAMETER_INTERFACE_INST

        public static final java.lang.String PAGE_PARAMETER_INTERFACE_INST
        See Also:
        Constant Field Values

      • PAGE_PARAMETER_NEW

        public static final java.lang.String PAGE_PARAMETER_NEW
        See Also:
        Constant Field Values

      • PAGE_PARAMETER_PREVIOUS

        public static final java.lang.String PAGE_PARAMETER_PREVIOUS
        See Also:
        Constant Field Values

      • PAGE_PARAMETER_PROCESS_ACTION

        public static final java.lang.String PAGE_PARAMETER_PROCESS_ACTION
        See Also:
        Constant Field Values

      • PAGE_PARAMETER_PAGEID

        public static final java.lang.String PAGE_PARAMETER_PAGEID
        See Also:
        Constant Field Values

      • PAGE_PARAMETER_CHANNELID

        public static final java.lang.String PAGE_PARAMETER_CHANNELID
        See Also:
        Constant Field Values

      • PAGE_PARAMETER_CLIENTRENDERED

        public static final java.lang.String PAGE_PARAMETER_CLIENTRENDERED
        See Also:
        Constant Field Values

      • PAGE_PARAMETER_REQUEST_FROM_HTML_FILE

        public static final java.lang.String PAGE_PARAMETER_REQUEST_FROM_HTML_FILE
        See Also:
        Constant Field Values

      • PAGE_PARAMETER_PAGE_CACHE_ID

        public static final java.lang.String PAGE_PARAMETER_PAGE_CACHE_ID
        See Also:
        Constant Field Values

      • PAGE_PARAMETER_LOCALE

        public static final java.lang.String PAGE_PARAMETER_LOCALE
        See Also:
        Constant Field Values

      • PAGE_PARAMETER_FROM_FORM

        public static final java.lang.String PAGE_PARAMETER_FROM_FORM
        See Also:
        Constant Field Values

      • PAGE_PARAMETER_HIGHLIGHT_INTERFACE_INST

        public static final java.lang.String PAGE_PARAMETER_HIGHLIGHT_INTERFACE_INST
        See Also:
        Constant Field Values

      • PAGE_PARAMETER_REPLACE_INTERFACE_COMMANDS

        public static final java.lang.String PAGE_PARAMETER_REPLACE_INTERFACE_COMMANDS
        See Also:
        Constant Field Values

      • PAGE_PARAMETER_REPLACE_INTERFACE_PARAMS

        public static final java.lang.String PAGE_PARAMETER_REPLACE_INTERFACE_PARAMS
        See Also:
        Constant Field Values

      • PAGE_PARAMETER_REPLACE_INTERFACES_STATE

        public static final java.lang.String PAGE_PARAMETER_REPLACE_INTERFACES_STATE
        See Also:
        Constant Field Values

      • PAGE_PARAMETER_RESIZE_CLIENT_WINDOW

        public static final java.lang.String PAGE_PARAMETER_RESIZE_CLIENT_WINDOW
        See Also:
        Constant Field Values

      • PAGE_PARAMETER_ORIGINAL_URL

        public static final java.lang.String PAGE_PARAMETER_ORIGINAL_URL
        See Also:
        Constant Field Values

      • PAGE_PARAMETER_SAFE_RENDER_MODE

        public static final java.lang.String PAGE_PARAMETER_SAFE_RENDER_MODE
        See Also:
        Constant Field Values

      • PAGE_PARAMETER_CLIENT_MESSAGE

        public static final java.lang.String PAGE_PARAMETER_CLIENT_MESSAGE
        See Also:
        Constant Field Values

      • PAGE_PARAMETER_FROM_ERROR

        public static final java.lang.String PAGE_PARAMETER_FROM_ERROR
        See Also:
        Constant Field Values

      • URL_REPLACEABLE_PARAMETER_PAGEID

        public static final java.lang.String URL_REPLACEABLE_PARAMETER_PAGEID
        See Also:
        Constant Field Values

      • PAGE_PARAMETER_REFERER

        public static final java.lang.String PAGE_PARAMETER_REFERER
        The location when the interface is client side.
        Since:
        7.0.0
        See Also:
        Constant Field Values

      • PAGE_PARAMETER_ORIGINAL_PAGEID

        public static final java.lang.String PAGE_PARAMETER_ORIGINAL_PAGEID
        See Also:
        Constant Field Values

      • PAGE_PARAMETER_TEMPORARY_MODE

        public static final java.lang.String PAGE_PARAMETER_TEMPORARY_MODE
        The parameter name used to represent the local mode.
        Since:
        6.0.0
        See Also:
        Constant Field Values

      • PAGE_PARAMETER_PREVIOUS_STORAGE_ID

        public static final java.lang.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 java.lang.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 java.lang.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

      • PAGE_PARAMETER_WRITER_KEYS

        public static final java.lang.String PAGE_PARAMETER_WRITER_KEYS
        Optional multi-valued parameter that contains the PortalPrintWriter keys already used in the page. Currently used only when the page is in administration perspective.
        Since:
        7.0.0
        See Also:
        Constant Field Values

      • PAGE_PARAMETER_TOGGLE_MODE_ORIGINAL_URL

        public static final java.lang.String PAGE_PARAMETER_TOGGLE_MODE_ORIGINAL_URL
        The parameter name used to represent toggle the current mode.
        Since:
        7.1.0
        See Also:
        Constant Field Values

      • PAGE_PARAMETER_CALLER_SERVICE_INST

        public static final java.lang.String PAGE_PARAMETER_CALLER_SERVICE_INST
        The parameter name used to provide the identifier of the service instance that is the caller of the current operation.
        Since:
        8.2.0
        See Also:
        Constant Field Values

      • PAGE_PARAMETER_CALLER_SERVICE_INTERFACE_MENU_LEVEL

        public static final java.lang.String PAGE_PARAMETER_CALLER_SERVICE_INTERFACE_MENU_LEVEL
        The parameter name used to provide the level of the service interface menu on the caller for which an interface is being executed. Value of this parameter corresponds to the ordinal of the enumeration value in ServiceInterfaceMenuLevel.
        Since:
        10.2.0
        See Also:
        Constant Field Values

      • PAGE_PARAMETER_CALLER_SERVICE_INTERFACE_MENU_ITEM

        public static final java.lang.String PAGE_PARAMETER_CALLER_SERVICE_INTERFACE_MENU_ITEM
        The parameter name used to identify the caller service interface menu item for which an interface is being executed.
        Since:
        10.2.0
        See Also:
        Constant Field Values

    • Method Detail

      • isReservedParameter

        public static boolean isReservedParameter​(java.lang.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 java.util.HashMap<java.lang.String,​java.lang.String[]> setParameters​(org.w3c.dom.Document parametersDoc)
                                                                           throws PortalException
        Throws:
        PortalException

      • getServiceInterfaceInstanceParameterNames

        public java.util.Enumeration<java.lang.String> getServiceInterfaceInstanceParameterNames​(java.lang.String serviceInterfaceInstanceId)
                                                                                  throws PortalException
        Throws:
        PortalException

      • getServiceInterfaceInstanceFileParameterValue

        public FileParameter getServiceInterfaceInstanceFileParameterValue​(java.lang.String name,
                                                                   java.lang.String serviceInterfaceInstanceId)

      • getServiceInterfaceInstanceParameterValue

        public java.lang.String getServiceInterfaceInstanceParameterValue​(java.lang.String name,
                                                                  java.lang.String serviceInterfaceInstanceId)
                                                           throws PortalException
        Throws:
        PortalException

      • getServiceInterfaceInstanceParameterValues

        public java.lang.String[] getServiceInterfaceInstanceParameterValues​(java.lang.String name,
                                                                     java.lang.String serviceInterfaceInstanceId)
                                                              throws PortalException
        Throws:
        PortalException

      • getServiceInterfaceInstanceParameters

        public java.util.Map<java.lang.String,​java.lang.String[]> getServiceInterfaceInstanceParameters​(java.lang.String serviceInterfaceInstanceId)
                                                                                               throws PortalException
        Throws:
        PortalException

      • applyServiceInterfaceInstanceParameters

        public void applyServiceInterfaceInstanceParameters​(java.lang.String serviceInterfaceInstanceId,
                                                    java.util.Map<java.lang.String,​java.lang.String[]> parameters)
        Applies service interface instance parameters, keeping previous values for portlet mode or window state parameters, if each did not change.
        Parameters:
        serviceInterfaceInstanceId - the service interface instance that is the target of the parameters.
        parameters - the parameters to be applied.
        Since:
        5.6.0

      • setServiceInterfaceInstanceParameters

        public void setServiceInterfaceInstanceParameters​(java.lang.String serviceInterfaceInstanceId,
                                                  java.util.Map<java.lang.String,​java.lang.String[]> parameters)
                                           throws PortalException
        Throws:
        PortalException

      • setServiceInterfaceInstanceFileParameters

        public void setServiceInterfaceInstanceFileParameters​(java.lang.String serviceInterfaceInstanceId,
                                                      java.util.Map<java.lang.String,​FileParameter> parameters)
                                               throws PortalException
        Throws:
        PortalException

      • setServiceInterfaceParameters

        public void setServiceInterfaceParameters​(java.lang.String serviceInterfaceId,
                                          java.util.Map<java.lang.String,​java.lang.String[]> parameters)
                                   throws PortalException
        Throws:
        PortalException

      • setServiceInstanceParameters

        public void setServiceInstanceParameters​(java.lang.String serviceInstanceId,
                                         java.util.Map<java.lang.String,​java.lang.String[]> parameters)
                                  throws PortalException
        Throws:
        PortalException

      • setServiceParameters

        public void setServiceParameters​(java.lang.String serviceId,
                                 java.util.Map<java.lang.String,​java.lang.String[]> parameters)
                          throws PortalException
        Throws:
        PortalException

      • setPageParameters

        public void setPageParameters​(java.util.Map<java.lang.String,​java.lang.String[]> parameters)
                       throws PortalException
        Throws:
        PortalException

      • setPageParameter

        public void setPageParameter​(java.lang.String parameterName,
                             java.lang.String[] parameterValues)
                      throws PortalException
        Throws:
        PortalException

      • getPreviousParametersStorageId

        public final java.lang.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 request are not found.
        Returns:
        the previous parameters storage id.
        Since:
        4.0.7

      • generatePreviousParameters

        public PortalRequestParameters.PreviousParameters generatePreviousParameters​(javax.servlet.http.HttpServletRequest request)
                                                                      throws PortalException
        Generate the previous parameters for this portal request parameters instance, storing it for automatic later retrieval. For the automatic later retrieval, 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