Interface IServiceInterfaceRequest

    • Method Detail

      • getAttributeNames

        java.util.Enumeration<java.lang.String> getAttributeNames()
        Returns an Enumeration containing the names of the attributes available to this request. This method returns an empty Enumeration if the request has no attributes available to it.
        Specified by:
        getAttributeNames in interface IPageWebResourceRequest
        Specified by:
        getAttributeNames in interface javax.portlet.PortletRequest
        Returns:
        an Enumeration of strings containing the names of the request attributes, or an empty Enumeration if the request has no attributes available to it.
      • getParameterNames

        java.util.Enumeration<java.lang.String> getParameterNames()
        Returns an Enumeration of String objects containing the names of the parameters contained in this request. If the request has no parameters, the method returns an empty Enumeration.

        Only parameters targeted to the current service interface are returned.

        Specified by:
        getParameterNames in interface IPageWebResourceRequest
        Specified by:
        getParameterNames in interface javax.portlet.PortletRequest
        Returns:
        an Enumeration of String objects, each String containing the name of a request parameter; or an empty Enumeration if the request has no parameters.
      • getParameterMap

        java.util.Map<java.lang.String,​java.lang.String[]> getParameterMap()
        Returns a Map of the parameters of this request. Request parameters are extra information sent with the request. The returned parameters are "x-www-form-urlencoded" decoded.

        The values in the returned Map are from type String array ( String[]).

        If no parameters exist this method returns an empty Map.

        Specified by:
        getParameterMap in interface IPageWebResourceRequest
        Specified by:
        getParameterMap in interface javax.portlet.PortletRequest
        Returns:
        an immutable Map containing parameter names as keys and parameter values as map values, or an empty Map if no parameters exist. The keys in the parameter map are of type String. The values in the parameter map are of type String array (String[]).
      • getServiceInterfaceInstanceId

        java.lang.String getServiceInterfaceInstanceId()
        Returns:
        Returns the serviceInterfaceInstanceId.
      • getPageConfig

        PageConfig getPageConfig()
        Returns:
      • setSessionConfig

        void setSessionConfig​(SessionConfig sessionConfig)
        Parameters:
        userSessionId -
      • getCookie

        Cookie getCookie​(java.lang.String cookieName)
        Description copied from interface: IPageWebResourceRequest
        Returns the requested cookie or null if the cookie does not exist in request.
        Specified by:
        getCookie in interface IPageWebResourceRequest
        Parameters:
        cookieName - the requested cookie name.
        Returns:
        the requested cookie or null if the cookie does not exist in request.
      • getHeader

        java.lang.String getHeader​(java.lang.String header)
        Description copied from interface: IPageWebResourceRequest
        Returns the requested header or null if the header does not exist in request.
        Specified by:
        getHeader in interface IPageWebResourceRequest
        Parameters:
        header - the requested header name.
        Returns:
        the requested header or null if the header does not exist in request.
      • getServiceInstanceDebugLevel

        int getServiceInstanceDebugLevel()
      • getCallerServiceInterfaceInstanceId

        java.lang.String getCallerServiceInterfaceInstanceId()
      • getCallerServiceInterfaceInstancePreferences

        IPreferences getCallerServiceInterfaceInstancePreferences()
        Returns the preferences of the caller service interface instance at level that corresponds to the menu level returned by getCallerServiceInterfaceMenuLevel().
        Returns:
        the preferences.
        Throws:
        java.lang.IllegalStateException - if either caller service interface instance or caller service interface menu level was not provided.
        Since:
        10.2.0
      • getPreferences

        IPreferences getPreferences()
        Specified by:
        getPreferences in interface javax.portlet.PortletRequest
      • getCallerServiceInterfaceMenuLevel

        ServiceInterfaceMenuLevel getCallerServiceInterfaceMenuLevel()
        Returns the service interface menu level that called the interface processed by this request.
        Returns:
        the menu level.
        Throws:
        java.lang.IllegalStateException - if there is no information about the caller menu service interface menu level available.
        Since:
        10.2.0
      • getMode

        int getMode()
      • setMode

        @Deprecated
        void setMode​(int mode)
        Deprecated.
        Since 7.1.0 as this method should not be used by service interfaces and may be removed in the future.