de.hybris.platform.cockpit.session

Interface UISession

All Known Implementing Classes:

DummyUISession, UISessionImpl

public interface UISession

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	PERSPECTIVE_ATTRIBUTE

Method Summary

Modifier and Type	Method and Description
void	addSessionListener(UISessionListener listener) Adds a session listener.
java.util.List<UICockpitPerspective>	getAvailablePerspectives() Returns all available perspectives.
UICockpitPerspective	getCurrentPerspective() Returns the current product cockpit perspective bean.
java.lang.String	getGlobalDataLanguageIso() Returns the isocode of the current data language.
java.util.Locale	getGlobalDataLocale()
JasperReportsRefresh	getJasperReportsRefresh() Returns service, which handles all page refresh requirements.
LabelService	getLabelService()
java.lang.String	getLanguageIso() Returns the isocode of the current session language.
java.util.Locale	getLocale()
ModelService	getModelService()
NewItemService	getNewItemService()
UICockpitPerspective	getPerspective(java.lang.String uid)
java.util.List<PushCreationContainer>	getPushContainers()
RequestHandler	getRequestHandler()
SavedQueryService	getSavedQueryService()
SearchService	getSearchService()
java.util.List<CatalogVersionModel>	getSelectedCatalogVersions()
SystemService	getSystemService()
TypeService	getTypeService()
UIAccessRightService	getUiAccessRightService()
UIConfigurationService	getUiConfigurationService()
UndoManager	getUndoManager()
UserModel	getUser() Returns the current ui session user.
ObjectValueHandlerRegistry	getValueHandlerRegistry()
boolean	isCachePerspectivesEnabled()
boolean	isDragOverPerspectivesEnabled()
boolean	isPerspectiveAvailable(java.lang.String uid)
boolean	isUsingTestIDs()
void	login(UserModel user) Assigns specified user to this session.
void	logout()
void	removeSessionListener(UISessionListener listener) Removes session listener.
void	sendGlobalEvent(CockpitEvent event) Processes given event.
void	sendGlobalEvent(CockpitEvent event, boolean immediate) Processes given event.
void	setCurrentPerspective(UICockpitPerspective perspective) Changes the current product perspective bean.
void	setCurrentPerspective(UICockpitPerspective perspective, java.util.Map<java.lang.String,? extends java.lang.Object> params)
void	setGlobalDataLanguageIso(java.lang.String iso)
void	setPushContainers(java.util.List<PushCreationContainer> pushContainers)
void	setRequestHandler(RequestHandler reqHandler)
void	setSelectedCatalogVersions(java.util.List<CatalogVersionModel> catalogVersions)
boolean	setSessionAttribute(java.lang.String key, java.lang.Object value)
void	setUser(UserModel currentUser) Changes the current session user.
void	setUserByUID(java.lang.String uid) Changes the current session user.

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)

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,
                           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)

getSelectedCatalogVersions

java.util.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(java.util.List<PushCreationContainer> pushContainers)

getPushContainers

java.util.List<PushCreationContainer> getPushContainers()

setSessionAttribute

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

getUiAccessRightService

UIAccessRightService getUiAccessRightService()

getJasperReportsRefresh

JasperReportsRefresh getJasperReportsRefresh()

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