Package de.hybris.platform.cockpit.session

Interface UISession

    • Field Detail

      • PERSPECTIVE_ATTRIBUTE

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

    • Method Detail

      • addSessionListener

        void addSessionListener​(UISessionListener listener)
        Adds a session listener.
        Parameters:
        listener - the new listener

      • removeSessionListener

        void removeSessionListener​(UISessionListener listener)
        Removes session listener.
        Parameters:
        listener - the listener to remove

      • getLanguageIso

        java.lang.String getLanguageIso()
        Returns the isocode of the current session language. Use getLocale() instead, if you want the locale before creating your own locale object
        Returns:
        current language iso code.

      • getGlobalDataLanguageIso

        java.lang.String getGlobalDataLanguageIso()
        Returns the isocode of the current data language. Use getGlobalDataLocale() instead, if you want the locale before creating your own locale object
        Returns:
        current data language iso code.

      • getLocale

        java.util.Locale getLocale()
        Returns:
        The locale for the currently selected language

      • getGlobalDataLocale

        java.util.Locale getGlobalDataLocale()
        Returns:
        the locale for the currently selected data language

      • setGlobalDataLanguageIso

        void setGlobalDataLanguageIso​(java.lang.String iso)

      • getUser

        UserModel getUser()
        Returns the current ui session user.

      • login

        void login​(UserModel user)
        Assigns specified user to this session.

      • logout

        void logout()

      • setUser

        void setUser​(UserModel currentUser)
        Changes the current session user.
        Parameters:
        currentUser - the new session user

      • setUserByUID

        void setUserByUID​(java.lang.String uid)
        Changes the current session user. This method accepts a user id and fetches the user object automatically.
        Parameters:
        uid -

      • getCurrentPerspective

        UICockpitPerspective getCurrentPerspective()
        Returns the current product cockpit perspective bean.

      • setCurrentPerspective

        void setCurrentPerspective​(UICockpitPerspective perspective,
                           java.util.Map<java.lang.String,​? extends java.lang.Object> params)

      • getAvailablePerspectives

        java.util.List<UICockpitPerspective> getAvailablePerspectives()
        Returns all available perspectives.

      • isPerspectiveAvailable

        boolean isPerspectiveAvailable​(java.lang.String uid)

      • getPerspective

        UICockpitPerspective getPerspective​(java.lang.String uid)
                             throws java.lang.IllegalArgumentException
        Throws:
        java.lang.IllegalArgumentException

      • setSelectedCatalogVersions

        void setSelectedCatalogVersions​(java.util.List<CatalogVersionModel> catalogVersions)

      • sendGlobalEvent

        void sendGlobalEvent​(CockpitEvent event)
        Processes given event. It will be dispatched to the current perspective.
        Parameters:
        event - the event to be processed

      • sendGlobalEvent

        void sendGlobalEvent​(CockpitEvent event,
                     boolean immediate)
        Processes given event. It will be dispatched to the current perspective.
        Parameters:
        event - the event to be processed
        immediate - force to send event immediately (not "on later")

      • isUsingTestIDs

        boolean isUsingTestIDs()

      • isDragOverPerspectivesEnabled

        boolean isDragOverPerspectivesEnabled()

      • isCachePerspectivesEnabled

        boolean isCachePerspectivesEnabled()

      • setRequestHandler

        void setRequestHandler​(RequestHandler reqHandler)

      • setSessionAttribute

        boolean setSessionAttribute​(java.lang.String key,
                            java.lang.Object value)

      • getJasperReportsRefresh

        JasperReportsRefresh getJasperReportsRefresh()
        Returns service, which handles all page refresh requirements. Currently used for Jasper reports only