org.openengsb.ui.common.taskbox
Interface WebTaskboxService

All Superinterfaces:

TaskboxService

All Known Implementing Classes:

WebTaskboxServiceImpl

public interface WebTaskboxService
extends TaskboxService

The WebTaskboxService extends the normal TaskboxService by adding some Wicket UI functionality. This includes the provisioning of tasks panels, an overview panel to display open tasks and a registration mechanism to define custom panels for certain task types.

Method Summary

org.apache.wicket.markup.html.panel.Panel	getOverviewPanel() Returns a Wicket panel which displays all open tasks.
org.apache.wicket.markup.html.panel.Panel	getTaskPanel(Task task, java.lang.String wicketPanelId) Gets the Wicket panel for the task type of the passed task.
void	registerTaskPanel(java.lang.String taskType, java.lang.Class<? extends org.apache.wicket.markup.html.panel.Panel> panelClass) Registers a custom Wicket panel for a certain task type.

Methods inherited from interface org.openengsb.core.api.workflow.TaskboxService

finishTask, getOpenTasks, getTaskForId, getTasksForExample, getTasksForProcessId, updateTask

Method Detail

getOverviewPanel

org.apache.wicket.markup.html.panel.Panel getOverviewPanel()

Returns a Wicket panel which displays all open tasks. It provides filtering and sorting capabilities. This panel has componentId="OverviewPanel" and style attribute class="OverviewPanel".

getTaskPanel

org.apache.wicket.markup.html.panel.Panel getTaskPanel(Task task,
                                                       java.lang.String wicketPanelId)
                                                       throws TaskboxException

Gets the Wicket panel for the task type of the passed task. If a custom panel was registered for this type before it gets returned, otherwise it falls back to the default task panel providing a generic user interface.

Throws:

TaskboxException - when the creation of the tasks panel fails

registerTaskPanel

void registerTaskPanel(java.lang.String taskType,
                       java.lang.Class<? extends org.apache.wicket.markup.html.panel.Panel> panelClass)
                       throws TaskboxException

Registers a custom Wicket panel for a certain task type. Any older registration for this type gets overwritten. The panel is provided via its class and needs a constructor with the ID as string for the first parameter and the Task as second.

Throws:

TaskboxException - when the panel could not be registered