Overview

Package

Class

Tree

Serialized

Deprecated

Index

Help

PREV class NEXT class

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

com.ibm.wps.portletservice.taskui
Interface TaskUIManager

All Superinterfaces:

org.apache.jetspeed.portlet.service.PortletService

All Known Implementing Classes:

TaskUIManagerImpl

public interface TaskUIManager

extends org.apache.jetspeed.portlet.service.PortletService

The TaskUIManager is a IBM Portal API service that provides functionality to manage the UI elements that were created for the processing of a task.

Since:

5.1

Method Summary
void	org.apache.jetspeed.portlet.event.ActionEvent, com.ibm.portal.taskui.TaskUIHandle)">closeDynamicUI(org.apache.jetspeed.portlet.event.ActionEvent actionEvent, TaskUIHandle handle) Closes the task UI element that is identified by the passed TaskUIHandle.
void	org.apache.jetspeed.portlet.event.ActionEvent, com.ibm.portal.ObjectID)">setPage(org.apache.jetspeed.portlet.event.ActionEvent actionEvent, com.ibm.portal.ObjectID objectID) Sets the page that should be displayed in the render phase following this action phase.

Method Detail

org.apache.jetspeed.portlet.event.ActionEvent, com.ibm.portal.taskui.TaskUIHandle)">

closeDynamicUI

public void closeDynamicUI(org.apache.jetspeed.portlet.event.ActionEvent actionEvent,
                           TaskUIHandle handle)
                    throws TaskUIManagerException

Closes the task UI element that is identified by the passed TaskUIHandle. None of the parameters is allowed to be null . The passed action event must be the original one passed to the portlet.

Parameters:

actionEvent - The action event.

handle - The TaskUIHandle.

Throws:

TaskUIManagerException - Thrown if an error occurs during processing.

org.apache.jetspeed.portlet.event.ActionEvent, com.ibm.portal.ObjectID)">

setPage

public void setPage(org.apache.jetspeed.portlet.event.ActionEvent actionEvent,
                    com.ibm.portal.ObjectID objectID)
             throws TaskUIManagerException

Sets the page that should be displayed in the render phase following this action phase. None of the parameters is allowed to be null . The passed action event must be the original one passed to the portlet.

Parameters:

actionEvent - The action event.

objectID - The id of the page to be selected.

Throws:

TaskUIManagerException - Thrown if an error occurs during processing.