com.plumtree.server
Interface IPTPageInfo

public interface IPTPageInfo

Author:

michaeld

Method Summary

int	GetAccessLevel() Get the ACL to this Page for the current user.
int	GetContainerClassID()
int	GetContainerObjectID()
boolean	GetInheritPageTemplate()
boolean	GetIsFirstPageInContainer()
java.lang.String	GetName() Gets the name of this Page
int	GetObjectID() Gets the Object ID of this Page
int	GetPageTemplateID()
int	GetPageType()
IPTMyPortalGadgetContent	QueryPortletContent(java.lang.Object objAppDataStateObject, java.lang.String strUserInterfaceID, int nMode, boolean bReturnAllPortlets) Query for the all of the Portlet content on the Page.
IPTMyPortalGadgetContent	QuerySpecificPortletContent(int[] nPortletIds, java.lang.Object objAppDataStateObject, java.lang.String strUserInterfaceID, int nMode) Query for one Portlet content on the Page.

Method Detail

GetName

java.lang.String GetName()

Gets the name of this Page

Returns:

String Name of current Page

GetObjectID

int GetObjectID()

Gets the Object ID of this Page

Returns:

Object ID of this Page

GetAccessLevel

int GetAccessLevel()

Get the ACL to this Page for the current user.

Returns:

An ACL defined in PT_ACCESS_LEVELS

See Also:

PT_ACCESS_LEVELS

GetPageType

int GetPageType()

Returns:

pagetype of the Page

GetPageTemplateID

int GetPageTemplateID()

Returns:

ID of Page Template of the Page

GetInheritPageTemplate

boolean GetInheritPageTemplate()

Returns:

whether the page inherits the page template set on the page

GetContainerClassID

int GetContainerClassID()

Returns:

Container Class ID

GetContainerObjectID

int GetContainerObjectID()

Returns:

Container Object ID

GetIsFirstPageInContainer

boolean GetIsFirstPageInContainer()

Returns:

whether this page is the first page in the container

QueryPortletContent

IPTMyPortalGadgetContent QueryPortletContent(java.lang.Object objAppDataStateObject,
                                             java.lang.String strUserInterfaceID,
                                             int nMode,
                                             boolean bReturnAllPortlets)

Query for the all of the Portlet content on the Page.

Parameters:

objAppDataStateObject - - Application data state object for this Page (and Page Container, if relevant)

strUserInterfaceID - - User interface id that needs to be supported ("" for all Portlets, "http://www.plumtree.com/uis/section508" for 508 compliant Portlets, etc.)

nMode - - Portlet mode (see PT_GADGET_MODES)

bReturnAllPortlets - - Boolean to return all Portlets regardless of interface

Returns:

IPTMyPortalGadgetContent - Content of the all the Portlets returned

QuerySpecificPortletContent

IPTMyPortalGadgetContent QuerySpecificPortletContent(int[] nPortletIds,
                                                     java.lang.Object objAppDataStateObject,
                                                     java.lang.String strUserInterfaceID,
                                                     int nMode)

Query for one Portlet content on the Page.

Parameters:

nPortletIds - - Ids of the portlets whose content is wanted

objAppDataStateObject - - Application data state object for this Page (and Page Container, if relevant)

strUserInterfaceID - - User interface id that needs to be supported ("" for all Portlets, "http://www.plumtree.com/uis/section508" for 508 compliant Portlets, etc.)

nMode - - Portlet mode (see PT_GADGET_MODES)

Returns:

IPTMyPortalGadgetContent - Content of the single Portlet returned