|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface IPTPage
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 |
---|
int GetTopicPos()
void SetPageType(int nPageType)
nPageType
- New pagetype for the Page
java.lang.Exception
- with PT_RESULTCODES.PT_E_INSUFFICIENTROLEACCESS if the user has insufficient
access to the Pageint GetPageType()
void SetPageTemplateID(int nPageTemplateID)
nPageTemplateID
- ID of Page Template for the Page
java.lang.Exception
- with PT_RESULTCODES.PT_E_INSUFFICIENTROLEACCESS if the user has insufficient
access to the Page or Page Templateint GetPageTemplateID()
void SetNotDeletable(boolean bIsNotDeletable)
bIsNotDeletable
- boolean value of whether the Page is deletable or not
java.lang.Exception
- with PT_RESULTCODES.PT_E_INSUFFICIENTROLEACCESS if the user has insufficient
access to the Pageboolean GetNotDeletable()
void SetInheritPageTemplate(boolean bInheritPageTemplate)
bInheritPageTemplate
- boolean GetInheritPageTemplate()
void SetDefaultsFromPageTemplate(int nPageTemplateID)
nPageTEmplateID
-
java.lang.Exception
- with PT_RESULTCODES.PT_E_INSUFFICIENTROLEACCESS if the user has insufficient
access to the Page Template.IPTQueryResult QueryPortlets()
void AddPortlet(int nPortletID, int nColumnID)
nPortletID
- - Portlet ID that is to be addednColumnID
- - Column ID in which to place the Portletvoid RemovePortlet(int nPortletID)
nPortletID
- - Portlet ID of the Portlet to removeIPTMyPortalGadgetContent QueryPortletContent(int nPageContainerClassID, int nPageContainerObjectID, java.lang.Object objAppDataStateObject, java.lang.String strUserInterfaceID, int nMode, boolean bReturnAllPortlets)
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
void AssignPortlets(int[] arrPortletIDs, int nColumnID)
arrPortletIDs
- - Array of Portlet IDs that are to be addednColumnID
- - Column ID in which to place all the Portletsvoid AssignPortlets(int nPortletID, int nColumnID)
nPortletID
- - Portlet ID that is to be addednColumnID
- - Column ID in which to place the Portlet
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |