org.osivia.services.taskbar.common.service

Interface ITaskbarPortletService

All Known Implementing Classes:

TaskbarPortletServiceImpl

public interface ITaskbarPortletService

Taskbar portlet service interface.

Author:

Cédric Krommenhoek

Method Summary

Modifier and Type	Method and Description
List<org.osivia.portal.api.taskbar.TaskbarItem>	getAvailableItems(org.osivia.portal.api.context.PortalControllerContext portalControllerContext) Get available taskbar items.
TaskbarConfiguration	getConfiguration(org.osivia.portal.api.context.PortalControllerContext portalControllerContext) Get taskbar configuration.
List<org.osivia.portal.api.taskbar.TaskbarItem>	getOrderedItems(org.osivia.portal.api.context.PortalControllerContext portalControllerContext) Get ordonned taskbar items.
List<Task>	getTasks(org.osivia.portal.api.context.PortalControllerContext portalControllerContext) Get tasks.
void	saveConfiguration(org.osivia.portal.api.context.PortalControllerContext portalControllerContext, TaskbarConfiguration configuration) Save taskbar configuration.
Task	start(org.osivia.portal.api.context.PortalControllerContext portalControllerContext, String id) Start task.
void	updateTasks(org.osivia.portal.api.context.PortalControllerContext portalControllerContext, List<Task> tasks) Update tasks.

Method Detail

getTasks

List<Task> getTasks(org.osivia.portal.api.context.PortalControllerContext portalControllerContext)
             throws javax.portlet.PortletException

Get tasks.

Parameters:

portalControllerContext - portal controller context

Returns:

tasks

Throws:

javax.portlet.PortletException

updateTasks

void updateTasks(org.osivia.portal.api.context.PortalControllerContext portalControllerContext,
                 List<Task> tasks)
          throws javax.portlet.PortletException

Update tasks.

Parameters:

portalControllerContext - portal controller context

tasks - tasks

Throws:

javax.portlet.PortletException

start

Task start(org.osivia.portal.api.context.PortalControllerContext portalControllerContext,
           String id)
    throws javax.portlet.PortletException

Start task.

Parameters:

portalControllerContext - portal controller context

id - task identifier

Returns:

task

Throws:

javax.portlet.PortletException

getOrderedItems

List<org.osivia.portal.api.taskbar.TaskbarItem> getOrderedItems(org.osivia.portal.api.context.PortalControllerContext portalControllerContext)
                                                         throws javax.portlet.PortletException

Get ordonned taskbar items.

Parameters:

portalControllerContext - portal controller context

Returns:

taskbar items

Throws:

javax.portlet.PortletException

getAvailableItems

List<org.osivia.portal.api.taskbar.TaskbarItem> getAvailableItems(org.osivia.portal.api.context.PortalControllerContext portalControllerContext)
                                                           throws javax.portlet.PortletException

Get available taskbar items.

Parameters:

portalControllerContext - portal controller context

Returns:

taskbar items

Throws:

javax.portlet.PortletException

getConfiguration

TaskbarConfiguration getConfiguration(org.osivia.portal.api.context.PortalControllerContext portalControllerContext)
                               throws javax.portlet.PortletException

Get taskbar configuration.

Parameters:

portalControllerContext - portlet controller context

Returns:

taskbar configuration

Throws:

javax.portlet.PortletException

saveConfiguration

void saveConfiguration(org.osivia.portal.api.context.PortalControllerContext portalControllerContext,
                       TaskbarConfiguration configuration)
                throws javax.portlet.PortletException

Save taskbar configuration.

Parameters:

portalControllerContext - portal controller context

configuration - taskbar configuration

Throws:

javax.portlet.PortletException