Interface UISession
- All Known Implementing Classes:
DummyUISession,UISessionImpl
public interface UISession
-
Field Summary
Fields -
Method Summary
Modifier and TypeMethodDescriptionvoidaddSessionListener(UISessionListener listener) Adds a session listener.Returns all available perspectives.Returns the current product cockpit perspective bean.Returns the isocode of the current data language.Returns service, which handles all page refresh requirements.Returns the isocode of the current session language.getPerspective(String uid) getUser()Returns the current ui session user.booleanbooleanbooleanbooleanvoidAssigns specified user to this session.voidlogout()voidremoveSessionListener(UISessionListener listener) Removes session listener.voidsendGlobalEvent(CockpitEvent event) Processes given event.voidsendGlobalEvent(CockpitEvent event, boolean immediate) Processes given event.voidsetCurrentPerspective(UICockpitPerspective perspective) Changes the current product perspective bean.voidsetCurrentPerspective(UICockpitPerspective perspective, Map<String, ? extends Object> params) voidvoidsetPushContainers(List<PushCreationContainer> pushContainers) voidsetRequestHandler(RequestHandler reqHandler) voidsetSelectedCatalogVersions(List<CatalogVersionModel> catalogVersions) booleansetSessionAttribute(String key, Object value) voidChanges the current session user.voidsetUserByUID(String uid) Changes the current session user.
-
Field Details
-
PERSPECTIVE_ATTRIBUTE
- See Also:
-
-
Method Details
-
addSessionListener
Adds a session listener.- Parameters:
listener- the new listener
-
removeSessionListener
Removes session listener.- Parameters:
listener- the listener to remove
-
getLanguageIso
String getLanguageIso()Returns the isocode of the current session language. UsegetLocale()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. UsegetGlobalDataLocale()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
-
getUser
UserModel getUser()Returns the current ui session user. -
login
Assigns specified user to this session. -
logout
void logout() -
setUser
Changes the current session user.- Parameters:
currentUser- the new session user
-
setUserByUID
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
Changes the current product perspective bean. Accepts one out ofgetAvailablePerspectives(). TriggersUISessionListener.perspectiveChanged(UICockpitPerspective, UICockpitPerspective).- Parameters:
perspective- the new perspective bean
-
setCurrentPerspective
-
getAvailablePerspectives
List<UICockpitPerspective> getAvailablePerspectives()Returns all available perspectives. -
isPerspectiveAvailable
-
getPerspective
- Throws:
IllegalArgumentException
-
setSelectedCatalogVersions
-
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
Processes given event. It will be dispatched to the current perspective.- Parameters:
event- the event to be processed
-
sendGlobalEvent
Processes given event. It will be dispatched to the current perspective.- Parameters:
event- the event to be processedimmediate- force to send event immediately (not "on later")
-
isUsingTestIDs
boolean isUsingTestIDs() -
isDragOverPerspectivesEnabled
boolean isDragOverPerspectivesEnabled() -
isCachePerspectivesEnabled
boolean isCachePerspectivesEnabled() -
setRequestHandler
-
getRequestHandler
RequestHandler getRequestHandler() -
setPushContainers
-
getPushContainers
List<PushCreationContainer> getPushContainers() -
setSessionAttribute
-
getUiAccessRightService
UIAccessRightService getUiAccessRightService() -
getJasperReportsRefresh
JasperReportsRefresh getJasperReportsRefresh()Returns service, which handles all page refresh requirements. Currently used for Jasper reports only
-