com.plumtree.portaluiinfrastructure.layout
Interface ILayoutChooser

All Known Implementing Classes:

LayoutChooser

public interface ILayoutChooser

This class is responsible for determining which Layout Web Service to use for each page.

Method Summary

IPTQueryResult	GetAvailableWebServices(Layouts _layout, AActivitySpace _asOwner) Get the web services that are available for the requested layout.
int	GetLayoutWebService(Layouts _layout, AActivitySpace _asOwner) Calculate the web service ID to use for the current page from the current Experience Definition.
boolean	GetPageLayoutsEnabled(AActivitySpace _asOwner)
boolean	GetPortletLayoutsEnabled(AActivitySpace _asOwner)

Method Detail

GetLayoutWebService

int GetLayoutWebService(Layouts _layout,
                        AActivitySpace _asOwner)

Calculate the web service ID to use for the current page from the current Experience Definition.

Parameters:

Layouts - the layout to used to calculate the layout Web Service.

AActivitySpace - the current Activity Space.

Returns:

int the Web Service ID to use for this page. -1 means layout is not enabled for this page at this time.

GetAvailableWebServices

IPTQueryResult GetAvailableWebServices(Layouts _layout,
                                       AActivitySpace _asOwner)

Get the web services that are available for the requested layout. These are stored in a special folder (one folder per layout) in the Admin Directory.

Parameters:

_layout - the requested layout

AActivitySpace - the current Activity Space.

Returns:

IPTQueryResult The list of available web services for this layout with name, description, and object ID information.

GetPageLayoutsEnabled

boolean GetPageLayoutsEnabled(AActivitySpace _asOwner)

Returns:

whether or not page layouts are enabled globally.

GetPortletLayoutsEnabled

boolean GetPortletLayoutsEnabled(AActivitySpace _asOwner)

Returns:

whether or not portlet layouts are enabled globally.