com.plumtree.portalpages.browsing.myportal
Interface IMyPortalModel

All Superinterfaces:
IModelRO, IMVCObject, IMyPortalModelRO
All Known Implementing Classes:
MyPortalModel

public interface IMyPortalModel
extends IMyPortalModelRO

Model interface used by plugin navigation. All setters and modifiers should go here.

Author:
btse

Method Summary
 void AddPortletBundle(int nPageID, int nPortletBundleID)
          Adds a portlet bundle to the page.
 void AddSinglePortlet(int nPageID, int nPortletId)
          Adds a single portlet to the page.
 void CollapsePortlet(int nCommunityID, int nPageID, int nPortletToCollapse)
          Collapses the gadget at the given index.
 void ExpandPortlet(int nCommunityID, int nPageID, int nPortletToExpand)
          Expands the gadget at the given index.
 boolean QueryRecentlyAddedPortletContent()
          Queries the portlet content of the recently added portlets, if there are any.
 boolean QueryRecentlyCollapsedExpandedPortletContent()
          Queries the portlet content of the recently collapsed portlets, if there are any.
 void ReassignPortlets(int[] arrPortletIDs, int nColumn, int nPageID)
          Reassigns the specified column (region) in the page with the given portlet array.
 void RemoveSinglePortlet(int nPageID, int nPortletIndex)
          Removes single portlet from the page.
 void ResetRecentlyAddedPortlets()
          Resets the list of recently added portlets.
 void ResetRecentlyCollapsedExpandedPortlet()
          Resets the variable to 0
 void ResetRecentlyRemovedPortlet()
          Resets the variable to 0
 boolean SetCommunity(int nCommunityID, int nPageID)
          Sets the community to be viewed and calls SetPage
 void SetIsPreviewPage(boolean bIsPreviewPage)
          Sets the page to be a preview page or not.
 boolean SetPage(int nPageID)
          Sets up the page of the given ID.
 boolean SetProfileID(int nProfileID)
          Method SetProfileID.
 void SetRawHeaders(java.lang.String strRawHeaders)
          Sets the raw headers from the request.
 void SetupIntrinsicPortlet(java.lang.String _strPortletClass, java.lang.String _strStorageName, int _nPortletIndex)
          Register model, view, and control for intrinsic portlet.
 
Methods inherited from interface com.plumtree.portalpages.browsing.myportal.IMyPortalModelRO
GetCollapsedOrErrorContent, GetCommunityID, GetCommunityName, GetCommunityPages, GetDisplayPortletHeaderDueToError, GetFirstPortletIndexInColumn, GetHelper, GetIDStringForPortlet, GetIsCommunityPage, GetLastPortletIndexInColumn, GetPageASURL, GetPageID, GetPageName, GetPageType, GetPortletAdminPrefsURL, GetPortletCollapsed, GetPortletCollapseExpandURL, GetPortletColumnFromIndex, GetPortletCommunityPrefsURL, GetPortletCount, GetPortletDisabledMessage, GetPortletEnabled, GetPortletHasAdminPrefsURL, GetPortletHasCollapseExpandURL, GetPortletHasCommunityPrefsURL, GetPortletHasHelpURL, GetPortletHasRefreshButton, GetPortletHasTitleBar, GetPortletHasUserPrefsURL, GetPortletHelpURL, GetPortletHTMLTextFromIndex, GetPortletIDFromIndex, GetPortletIsMandatory, GetPortletLayoutId, GetPortletNameFromIndex, GetPortletPrefButtonBoolean, GetPortletPreferenceActionsData, GetPortletRemoveURL, GetPortletSupports508, GetPortletSupportsPersonalization, GetPortletUserPrefsURL, GetPortletUUID, GetProfileID, GetRecentlyAddedPortlets, GetRecentlyCollapsedExpandedPortlet, GetRecentlyRemovedPortlet, GetSession, SetDisplayPortletHeaderDueToError, UsesPortletLayout
 
Methods inherited from interface com.plumtree.uiinfrastructure.activityspace.IMVCObject
GetName
 

Method Detail

AddSinglePortlet

void AddSinglePortlet(int nPageID,
                      int nPortletId)
Adds a single portlet to the page. First opens the page, locks it, adds the portlet, stores and unlocks the page.

Parameters:
nPageID -
nPortletID -

AddPortletBundle

void AddPortletBundle(int nPageID,
                      int nPortletBundleID)
Adds a portlet bundle to the page. First opens the page, locks it, adds the portlets, stores and unlocks the page.

Parameters:
nPageID -
nPortletBundleID -

CollapsePortlet

void CollapsePortlet(int nCommunityID,
                     int nPageID,
                     int nPortletToCollapse)
Collapses the gadget at the given index.

Parameters:
nPortletIndex - nPortletID

ExpandPortlet

void ExpandPortlet(int nCommunityID,
                   int nPageID,
                   int nPortletToExpand)
Expands the gadget at the given index.

Parameters:
nPortletIndex - nPortletID

ReassignPortlets

void ReassignPortlets(int[] arrPortletIDs,
                      int nColumn,
                      int nPageID)
Reassigns the specified column (region) in the page with the given portlet array.

Parameters:
arrPortletIDs - array of portlet IDs
nColumn - nColumn
nPageID - nPageID

RemoveSinglePortlet

void RemoveSinglePortlet(int nPageID,
                         int nPortletIndex)
Removes single portlet from the page. First opens the page and locks it Remove the portlet, stores and unlocks the page.

Parameters:
nPageID -
nPortletIndex -

SetCommunity

boolean SetCommunity(int nCommunityID,
                     int nPageID)
Sets the community to be viewed and calls SetPage

Parameters:
nCommunityID - nCommunityID
nPageID - nPageID
Returns:
true if successful, else false

SetIsPreviewPage

void SetIsPreviewPage(boolean bIsPreviewPage)
Sets the page to be a preview page or not.

Parameters:
bIsPreviewPage - bIsPreviewPage

SetPage

boolean SetPage(int nPageID)
Sets up the page of the given ID.

Parameters:
nPageID - nPageID
Returns:
true if successful, else false; false requires login redirect

SetProfileID

boolean SetProfileID(int nProfileID)
Method SetProfileID. Returns false if the current user doesn't have access to the given profile.

Parameters:
nProfileID -
Returns:
true if successful, else false

SetRawHeaders

void SetRawHeaders(java.lang.String strRawHeaders)
Sets the raw headers from the request.

Parameters:
strRawHeaders -

ResetRecentlyAddedPortlets

void ResetRecentlyAddedPortlets()
Resets the list of recently added portlets.


QueryRecentlyAddedPortletContent

boolean QueryRecentlyAddedPortletContent()
Queries the portlet content of the recently added portlets, if there are any. Does nothing if there are no recently added portlets (including not resetting the content data), so be sure to check that there are recently added portlets before calling this.


QueryRecentlyCollapsedExpandedPortletContent

boolean QueryRecentlyCollapsedExpandedPortletContent()
Queries the portlet content of the recently collapsed portlets, if there are any. Does nothing if there are no recently collapsed portlets (including not resetting the content data), so be sure to check that there are recently collapsed portlets before calling this.


ResetRecentlyRemovedPortlet

void ResetRecentlyRemovedPortlet()
Resets the variable to 0


ResetRecentlyCollapsedExpandedPortlet

void ResetRecentlyCollapsedExpandedPortlet()
Resets the variable to 0


SetupIntrinsicPortlet

void SetupIntrinsicPortlet(java.lang.String _strPortletClass,
                           java.lang.String _strStorageName,
                           int _nPortletIndex)
Register model, view, and control for intrinsic portlet. Initialize portlet with the portletID, the IPTMyPortal object, and the AppDataState object.

Parameters:
_strPortletClass - Class identifier for portlet
_strStorageName - Storage name for portlet
_nPortletIndex - Portlet index
Throws:
XPException - Exception thrown if model, view, or control is not registered successfully.



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