org.osivia.portal.api.taskbar

Interface ITaskbarService

public interface ITaskbarService

Taskbar service interface.

Author:

Cédric Krommenhoek

Field Summary

Fields

Modifier and Type	Field and Description
static String	HOME_TASK_ID Taskbar home task identifier.
static String	LINKED_TASK_ID_WINDOW_PROPERTY Linked taskbar task identifier window property name.
static String	MBEAN_NAME MBean name.
static String	SEARCH_TASK_ID Taskbar search task identifier.
static String	TASK_ID_WINDOW_PROPERTY Taskbar task identifier window property name.
static String	WEBID_PREFIX Taskbar task webId prefix.
static String	WINDOW_INSTANCE Taskbar window instance.

Method Summary

Methods

Modifier and Type	Method and Description
String	getActiveId(PortalControllerContext portalControllerContext) Get active taskbar task identifier.
List<TaskbarTask>	getAllTasks(PortalControllerContext portalControllerContext, String basePath, boolean superUser) Get taskbar tasks.
SortedSet<TaskbarItem>	getDefaultItems(PortalControllerContext portalControllerContext) Get default taskbar items, sorted by order.
TaskbarFactory	getFactory() Get taskbar item factory.
TaskbarItem	getItem(PortalControllerContext portalControllerContext, String id) Get taskbar item.
TaskbarItems	getItems(PortalControllerContext portalControllerContext) Get taskbar items.
TaskbarTask	getTask(PortalControllerContext portalControllerContext, String basePath, String id) Get taskbar task.
List<TaskbarTask>	getTasks(PortalControllerContext portalControllerContext, String basePath) Get taskbar tasks.
List<TaskbarTask>	getTasks(PortalControllerContext portalControllerContext, String basePath, boolean navigation) Deprecated.

Field Detail

MBEAN_NAME

static final String MBEAN_NAME

MBean name.

See Also:

Constant Field Values

WEBID_PREFIX

static final String WEBID_PREFIX

Taskbar task webId prefix.

See Also:

Constant Field Values

WINDOW_INSTANCE

static final String WINDOW_INSTANCE

Taskbar window instance.

See Also:

Constant Field Values

HOME_TASK_ID

static final String HOME_TASK_ID

Taskbar home task identifier.

See Also:

Constant Field Values

SEARCH_TASK_ID

static final String SEARCH_TASK_ID

Taskbar search task identifier.

See Also:

Constant Field Values

TASK_ID_WINDOW_PROPERTY

static final String TASK_ID_WINDOW_PROPERTY

Taskbar task identifier window property name.

See Also:

Constant Field Values

LINKED_TASK_ID_WINDOW_PROPERTY

static final String LINKED_TASK_ID_WINDOW_PROPERTY

Linked taskbar task identifier window property name.

See Also:

Constant Field Values

Method Detail

getFactory

TaskbarFactory getFactory()

Get taskbar item factory.

Returns:

taskbar item factory

getItems

TaskbarItems getItems(PortalControllerContext portalControllerContext)
                      throws PortalException

Get taskbar items.

Parameters:

portalControllerContext - portal controller context

Returns:

taskbar items

Throws:

PortalException

getItem

TaskbarItem getItem(PortalControllerContext portalControllerContext,
                  String id)
                    throws PortalException

Get taskbar item.

Parameters:

portalControllerContext - portal controller context

id - taskbar item identifier

Returns:

taskbar item

Throws:

PortalException

getDefaultItems

SortedSet<TaskbarItem> getDefaultItems(PortalControllerContext portalControllerContext)
                                       throws PortalException

Get default taskbar items, sorted by order.

Parameters:

portalControllerContext - portal controller context

Returns:

taskbar items

Throws:

PortalException

getTasks

@Deprecated
List<TaskbarTask> getTasks(PortalControllerContext portalControllerContext,
                                    String basePath,
                                    boolean navigation)
                           throws PortalException

Deprecated.

Get taskbar tasks.

Parameters:

portalControllerContext - portal controller context

basePath - CMS base path

navigation - navigation usage indicator

Returns:

tasks

Throws:

PortalException

getTasks

List<TaskbarTask> getTasks(PortalControllerContext portalControllerContext,
                         String basePath)
                           throws PortalException

Get taskbar tasks.

Parameters:

portalControllerContext - portal controller context

basePath - CMS base path

navigation - navigation usage indicator

Returns:

tasks

Throws:

PortalException

getAllTasks

List<TaskbarTask> getAllTasks(PortalControllerContext portalControllerContext,
                            String basePath,
                            boolean superUser)
                              throws PortalException

Get taskbar tasks.

Parameters:

portalControllerContext - portal controller context

basePath - CMS base path

navigation - navigation usage indicator

Returns:

tasks

Throws:

PortalException

getTask

TaskbarTask getTask(PortalControllerContext portalControllerContext,
                  String basePath,
                  String id)
                    throws PortalException

Get taskbar task.

Parameters:

portalControllerContext - portal controller context

basePath - CMS base path

id - taskbar task identifier

Returns:

taskbar task

Throws:

PortalException

getActiveId

String getActiveId(PortalControllerContext portalControllerContext)
                   throws PortalException

Get active taskbar task identifier.

Parameters:

portalControllerContext - portal controller context

Returns:

taskbar task identifier

Throws:

PortalException