Package org.craftercms.studio.api.v2.service.ui

Interface UiService

All Known Implementing Classes:

UiServiceImpl

public interface UiService

Service that provides the UI elements the current user has access to.

Author:

avasquez

Method Summary

Modifier and Type	Method	Description
String	getActiveEnvironment()	Returns the active environment.
List<MenuItem>	getGlobalMenu()	Returns the global menu items available to the current user.

Method Details

getGlobalMenu

List<MenuItem> getGlobalMenu()
                      throws AuthenticationException,
ServiceLayerException

Returns the global menu items available to the current user.

Returns:

the list of menu items

Throws:

AuthenticationException - if not user is logged in

ServiceLayerException - if another error occurs

getActiveEnvironment

String getActiveEnvironment()
                     throws AuthenticationException

Returns the active environment.

Returns:

active environment

Throws:

AuthenticationException - authentication error