org.osivia.portal.api.panels

Interface IPanelsService

public interface IPanelsService

Panels service interface.

Author:

Cédric Krommenhoek

Field Summary

Fields

Modifier and Type	Field and Description
static String	MBEAN_NAME MBean name.
static String	PAGE_REQUEST_ATTRIBUTE Page request attribute name.
static String	REQUEST_ATTRIBUTE Displayed panels indicator request attribute name.

Method Summary

Modifier and Type	Method and Description
void	closePanel(PortalControllerContext portalControllerContext, Panel panel) Close panel.
PanelPlayer	getNavigationPlayer(PortalControllerContext portalControllerContext, String instance) Get navigation panel player.
void	hidePanel(PortalControllerContext portalControllerContext, Panel panel) Hide previously created panel.
Boolean	isHidden(PortalControllerContext portalControllerContext, Panel panel) Check if panel is hidden.
void	openPanel(PortalControllerContext portalControllerContext, Panel panel, PanelPlayer player) Open panel.
void	resetTaskDependentPanels(PortalControllerContext portalControllerContext)
void	showPanel(PortalControllerContext portalControllerContext, Panel panel) Show previously created panel.

Field Detail

MBEAN_NAME

static final String MBEAN_NAME

MBean name.

See Also:

Constant Field Values

REQUEST_ATTRIBUTE

static final String REQUEST_ATTRIBUTE

Displayed panels indicator request attribute name.

See Also:

Constant Field Values

PAGE_REQUEST_ATTRIBUTE

static final String PAGE_REQUEST_ATTRIBUTE

Page request attribute name.

See Also:

Constant Field Values

Method Detail

openPanel

void openPanel(PortalControllerContext portalControllerContext,
               Panel panel,
               PanelPlayer player)
        throws PortalException

Open panel.

Parameters:

portalControllerContext - portal controller context

panel - panel

player - panel player

Throws:

PortalException

closePanel

void closePanel(PortalControllerContext portalControllerContext,
                Panel panel)
         throws PortalException

Close panel.

Parameters:

portalControllerContext - portal controller context

panel - panel

Throws:

PortalException

showPanel

void showPanel(PortalControllerContext portalControllerContext,
               Panel panel)
        throws PortalException

Show previously created panel.

Parameters:

portalControllerContext - portal controller context

panel - panel

Throws:

PortalException

hidePanel

void hidePanel(PortalControllerContext portalControllerContext,
               Panel panel)
        throws PortalException

Hide previously created panel.

Parameters:

portalControllerContext - portal controller context

panel - panel

Throws:

PortalException

isHidden

Boolean isHidden(PortalControllerContext portalControllerContext,
                 Panel panel)
          throws PortalException

Check if panel is hidden.

Parameters:

portalControllerContext - portal controller context

panel - panel

Returns:

hidden panel indicator

Throws:

PortalException

resetTaskDependentPanels

void resetTaskDependentPanels(PortalControllerContext portalControllerContext)
                       throws PortalException

Throws:

PortalException

getNavigationPlayer

PanelPlayer getNavigationPlayer(PortalControllerContext portalControllerContext,
                                String instance)
                         throws PortalException

Get navigation panel player.

Parameters:

portalControllerContext - portal controller context

Returns:

panel player

Throws:

PortalException