com.plumtree.portaluiinfrastructure.layout.impl
Class LayoutChooser

java.lang.Object
  extended by com.plumtree.portaluiinfrastructure.layout.impl.LayoutChooser
All Implemented Interfaces:
ILayoutChooser

public class LayoutChooser
extends java.lang.Object
implements ILayoutChooser


Field Summary
static int ALL_LAYOUTS_DISABLED
           
static int ALL_LAYOUTS_ENABLED
           
protected  int m_nLayoutMode
           
static int PAGE_LAYOUTS_ENABLED
           
static int PORTLET_LAYOUTS_ENABLED
           
 
Constructor Summary
LayoutChooser(java.lang.Object _oKey)
          To make sure people don't create LayoutChoosers directly, we require a special key that only the LayoutService has.
 
Method Summary
protected  void CacheLayoutMode(AActivitySpace _asOwner)
          This method caches the layout mode if it isn't already cached.
 IPTQueryResult GetAvailableWebServices(Layouts _layout, AActivitySpace _space)
          Get the web services that are available for the requested layout.
protected  int GetLayoutIDForExperience(Layouts _layout, AActivitySpace _space)
           
protected  boolean GetLayoutsEnabledForExperience(AActivitySpace _space)
           
 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)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

ALL_LAYOUTS_DISABLED

public static final int ALL_LAYOUTS_DISABLED
See Also:
Constant Field Values

ALL_LAYOUTS_ENABLED

public static final int ALL_LAYOUTS_ENABLED
See Also:
Constant Field Values

PAGE_LAYOUTS_ENABLED

public static final int PAGE_LAYOUTS_ENABLED
See Also:
Constant Field Values

PORTLET_LAYOUTS_ENABLED

public static final int PORTLET_LAYOUTS_ENABLED
See Also:
Constant Field Values

m_nLayoutMode

protected int m_nLayoutMode
Constructor Detail

LayoutChooser

public LayoutChooser(java.lang.Object _oKey)
To make sure people don't create LayoutChoosers directly, we require a special key that only the LayoutService has. Call LayoutService.getChooserInstance() instead to get the Layout Chooser.

Parameters:
_oKey -
Method Detail

GetLayoutWebService

public int GetLayoutWebService(Layouts _layout,
                               AActivitySpace _asOwner)
Description copied from interface: ILayoutChooser
Calculate the web service ID to use for the current page from the current Experience Definition.

Specified by:
GetLayoutWebService in interface ILayoutChooser
Returns:
int the Web Service ID to use for this page. -1 means layout is not enabled for this page at this time.

GetPageLayoutsEnabled

public boolean GetPageLayoutsEnabled(AActivitySpace _asOwner)
Specified by:
GetPageLayoutsEnabled in interface ILayoutChooser
Returns:
whether or not page layouts are enabled globally.

GetPortletLayoutsEnabled

public boolean GetPortletLayoutsEnabled(AActivitySpace _asOwner)
Specified by:
GetPortletLayoutsEnabled in interface ILayoutChooser
Returns:
whether or not portlet layouts are enabled globally.

CacheLayoutMode

protected void CacheLayoutMode(AActivitySpace _asOwner)
This method caches the layout mode if it isn't already cached.

Parameters:
_asOwner -

GetLayoutIDForExperience

protected int GetLayoutIDForExperience(Layouts _layout,
                                       AActivitySpace _space)

GetLayoutsEnabledForExperience

protected boolean GetLayoutsEnabledForExperience(AActivitySpace _space)

GetAvailableWebServices

public IPTQueryResult GetAvailableWebServices(Layouts _layout,
                                              AActivitySpace _space)
Description copied from interface: ILayoutChooser
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.

Specified by:
GetAvailableWebServices in interface ILayoutChooser
Parameters:
_layout - the requested layout
Returns:
IPTQueryResult The list of available web services for this layout with name, description, and object ID information.



Copyright © 2002,2003,2004,2005 Plumtree Software, Inc., All Rights Reserved.