Interface UISession

All Known Implementing Classes:
DummyUISession, UISessionImpl

public interface UISession
  • Field Details

  • Method Details

    • 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

      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

      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

      Locale getLocale()
      Returns:
      The locale for the currently selected language
    • getGlobalDataLocale

      Locale getGlobalDataLocale()
      Returns:
      the locale for the currently selected data language
    • setGlobalDataLanguageIso

      void setGlobalDataLanguageIso(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(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)
      Changes the current product perspective bean. Accepts one out of getAvailablePerspectives(). Triggers UISessionListener.perspectiveChanged(UICockpitPerspective, UICockpitPerspective).
      Parameters:
      perspective - the new perspective bean
    • setCurrentPerspective

      void setCurrentPerspective(UICockpitPerspective perspective, Map<String,? extends Object> params)
    • getAvailablePerspectives

      List<UICockpitPerspective> getAvailablePerspectives()
      Returns all available perspectives.
    • isPerspectiveAvailable

      boolean isPerspectiveAvailable(String uid)
    • getPerspective

      Throws:
      IllegalArgumentException
    • setSelectedCatalogVersions

      void setSelectedCatalogVersions(List<CatalogVersionModel> catalogVersions)
    • getSelectedCatalogVersions

      List<CatalogVersionModel> getSelectedCatalogVersions()
    • getSystemService

      SystemService getSystemService()
    • getTypeService

      TypeService getTypeService()
    • getNewItemService

      NewItemService getNewItemService()
    • getValueHandlerRegistry

      ObjectValueHandlerRegistry getValueHandlerRegistry()
    • getLabelService

      LabelService getLabelService()
    • getSearchService

      SearchService getSearchService()
    • getSavedQueryService

      SavedQueryService getSavedQueryService()
    • getUiConfigurationService

      UIConfigurationService getUiConfigurationService()
    • getModelService

      ModelService getModelService()
    • getUndoManager

      UndoManager getUndoManager()
    • 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)
    • getRequestHandler

      RequestHandler getRequestHandler()
    • setPushContainers

      void setPushContainers(List<PushCreationContainer> pushContainers)
    • getPushContainers

      List<PushCreationContainer> getPushContainers()
    • setSessionAttribute

      boolean setSessionAttribute(String key, Object value)
    • getUiAccessRightService

      UIAccessRightService getUiAccessRightService()
    • getJasperReportsRefresh

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