com.plumtree.server
Interface IPTPage

All Superinterfaces:

IPTLocalizable, IPTObject, IPTServerContext, IPTStorable, IPTUnknown

public interface IPTPage
extends IPTObject

Author:

Michael DeCourcey

Method Summary

void	AddPortlet(int nPortletID, int nColumnID) Add a Portlet to a column on the Page.
void	AssignPortlets(int[] arrPortletIDs, int nColumnID) Assign a list of Portlets to a column on the Page.
void	AssignPortlets(int nPortletID, int nColumnID) Assign a Portlet to a column on the page.
boolean	GetInheritPageTemplate()
boolean	GetNotDeletable()
int	GetPageTemplateID()
int	GetPageType()
int	GetTopicPos()
IPTMyPortalGadgetContent	QueryPortletContent(int nPageContainerClassID, int nPageContainerObjectID, java.lang.Object objAppDataStateObject, java.lang.String strUserInterfaceID, int nMode, boolean bReturnAllPortlets) Query for the all of the Portlet content on the Page.
IPTQueryResult	QueryPortlets() Query for all the Portlets on the Page.
void	RemovePortlet(int nPortletID) Remove one Portlet from the Page.
void	SetDefaultsFromPageTemplate(int nPageTemplateID) Set the page name, primary language, is localized, localized page names, page type settings on the page from the settings on the page template passed in.
void	SetInheritPageTemplate(boolean bInheritPageTemplate) Set whether the Page should inherit the settings of the page template.
void	SetNotDeletable(boolean bIsNotDeletable) Set whether the Page is deletable or not.
void	SetPageTemplateID(int nPageTemplateID) Set the Page Template for the Page.
void	SetPageType(int nPageType) Set a pagetype for the Page.

Methods inherited from interface com.plumtree.server.IPTObject

GetAdminFolderID, GetClassID, GetCreated, GetImageUUID, GetLastModified, GetObjectProperties, SetAdminFolderID, SetImageUUID, SetLastModified

Methods inherited from interface com.plumtree.server.IPTLocalizable

GetDescription, GetIsLocalized, GetLocalizedDescription, GetLocalizedDescriptions, GetLocalizedName, GetLocalizedNames, GetName, GetPrimaryLang, GetSupportsLocalization, SetDescription, SetIsLocalized, SetLocalizedDescriptions, SetLocalizedNames, SetName, SetPrimaryLang

Methods inherited from interface com.plumtree.server.IPTUnknown

GetInterfaces

Methods inherited from interface com.plumtree.server.IPTServerContext

GetAccessLevel, GetACL, GetLastModifiedBy, GetLockState, GetObjectID, GetOwnerID, GetServerContextSettings, GetSession, GetSettings, LockObject, SetLastModifiedBy, SetObjectID, SetOwnerID, SetServerContextSettings, SetSettings, UnlockObject

Methods inherited from interface com.plumtree.server.IPTStorable

Store

Method Detail

GetTopicPos

int GetTopicPos()

Returns:

the position of the page in its container if it has one

SetPageType

void SetPageType(int nPageType)

Set a pagetype for the Page. Requires EDIT access to the Page.

Parameters:

nPageType - New pagetype for the Page

Throws:

java.lang.Exception - with PT_RESULTCODES.PT_E_INSUFFICIENTROLEACCESS if the user has insufficient access to the Page

GetPageType

int GetPageType()

Returns:

pagetype of the Page

SetPageTemplateID

void SetPageTemplateID(int nPageTemplateID)

Set the Page Template for the Page. Requires EDIT access to the Page and SELECT on the Page Template.

Parameters:

nPageTemplateID - ID of Page Template for the Page

Throws:

java.lang.Exception - with PT_RESULTCODES.PT_E_INSUFFICIENTROLEACCESS if the user has insufficient access to the Page or Page Template

GetPageTemplateID

int GetPageTemplateID()

Returns:

ID of Page Template of the Page

SetNotDeletable

void SetNotDeletable(boolean bIsNotDeletable)

Set whether the Page is deletable or not. Requires EDIT access to the Page.

Parameters:

bIsNotDeletable - boolean value of whether the Page is deletable or not

Throws:

java.lang.Exception - with PT_RESULTCODES.PT_E_INSUFFICIENTROLEACCESS if the user has insufficient access to the Page

GetNotDeletable

boolean GetNotDeletable()

Returns:

whether the Page is deletable or not.

SetInheritPageTemplate

void SetInheritPageTemplate(boolean bInheritPageTemplate)

Set whether the Page should inherit the settings of the page template. It is true by default. This setting can only be changed when the page is being created. If it is set to false and it used to be true, then the Page will copy the current settings of the page template and it will not inherit future changes to the page template. Setting it to false, when it was already false will have no affect. It cannot be set to true, once it has been set to false.

Parameters:

bInheritPageTemplate -

GetInheritPageTemplate

boolean GetInheritPageTemplate()

Returns:

whether the Page should inherit the settings of the page template. If it returns false, then the Page copied the current settings of the page template and it will not inherit future changes to the page template.

SetDefaultsFromPageTemplate

void SetDefaultsFromPageTemplate(int nPageTemplateID)

Set the page name, primary language, is localized, localized page names, page type settings on the page from the settings on the page template passed in.

Parameters:

nPageTEmplateID -

Throws:

java.lang.Exception - with PT_RESULTCODES.PT_E_INSUFFICIENTROLEACCESS if the user has insufficient access to the Page Template.

QueryPortlets

IPTQueryResult QueryPortlets()

Query for all the Portlets on the Page.

Returns:

IPTQueryResult with the following PROPIDS: PT_PROPIDS.PT_PROPID_OBJECTID PT_PROPIDS.PT_PROPID_MYPORTAL_TOPICPOS PT_PROPIDS.PT_PROPID_GADGET_COLUMN PT_PROPIDS.PT_PROPID_NAME PT_PROPIDS.PT_PROPID_DESCRIPTION PT_PROPIDS.PT_PROPID_ISLOCALIZED PT_PROPIDS.PT_PROPID_FOLDERID PT_PROPIDS.PT_PROPID_WEBSERVICE_PERSONALIZATION PT_PROPIDS.PT_PROPID_GADGET_ALIGNMENT PT_PROPIDS.PT_PROPID_GADGET_GADGETTYPE PT_PROPIDS.PT_PROPID_GADGET_FLAGS PT_PROPIDS.PT_PROPID_GADGET_FROMPAGETEMPLATE

AddPortlet

void AddPortlet(int nPortletID,
                int nColumnID)

Add a Portlet to a column on the Page. It adds this Portlet to the Portlets that are already in this column.

Parameters:

nPortletID - - Portlet ID that is to be added

nColumnID - - Column ID in which to place the Portlet

RemovePortlet

void RemovePortlet(int nPortletID)

Remove one Portlet from the Page.

Parameters:

nPortletID - - Portlet ID of the Portlet to remove

QueryPortletContent

IPTMyPortalGadgetContent QueryPortletContent(int nPageContainerClassID,
                                             int nPageContainerObjectID,
                                             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

AssignPortlets

void AssignPortlets(int[] arrPortletIDs,
                    int nColumnID)

Assign a list of Portlets to a column on the Page. It clears all Portlets from the column before adding the Portlets in the array.

Parameters:

arrPortletIDs - - Array of Portlet IDs that are to be added

nColumnID - - Column ID in which to place all the Portlets

AssignPortlets

void AssignPortlets(int nPortletID,
                    int nColumnID)

Assign a Portlet to a column on the page. It clears all Portlets from the column before adding the Portlet.

Parameters:

nPortletID - - Portlet ID that is to be added

nColumnID - - Column ID in which to place the Portlet