org.osivia.services.taskbar.portlet.service

Interface TaskbarPortletService

All Known Implementing Classes:

TaskbarPortletServiceImpl

public interface TaskbarPortletService

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.
List<org.osivia.portal.api.taskbar.TaskbarItem>	getOrderedItems(org.osivia.portal.api.context.PortalControllerContext portalControllerContext) Get ordonned taskbar items.
TaskbarSettings	getSettings(org.osivia.portal.api.context.PortalControllerContext portalControllerContext) Get taskbar settings.
List<Task>	getTasks(org.osivia.portal.api.context.PortalControllerContext portalControllerContext, TaskbarSettings settings) Get tasks.
void	saveSettings(org.osivia.portal.api.context.PortalControllerContext portalControllerContext, TaskbarSettings configuration) Save taskbar settings.
Task	start(org.osivia.portal.api.context.PortalControllerContext portalControllerContext, TaskbarSettings settings, 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,
                    TaskbarSettings settings)
             throws javax.portlet.PortletException

Get tasks.

Parameters:

portalControllerContext - portal controller context

settings - taskbar settings

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,
           TaskbarSettings settings,
           String id)
    throws javax.portlet.PortletException

Start task.

Parameters:

portalControllerContext - portal controller context

settings - taskbar settings

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

getSettings

TaskbarSettings getSettings(org.osivia.portal.api.context.PortalControllerContext portalControllerContext)
                     throws javax.portlet.PortletException

Get taskbar settings.

Parameters:

portalControllerContext - portlet controller context

Returns:

taskbar settings

Throws:

javax.portlet.PortletException

saveSettings

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

Save taskbar settings.

Parameters:

portalControllerContext - portal controller context

configuration - taskbar settings

Throws:

javax.portlet.PortletException