com.plumtree.portalpages.browsing.myportal
Interface IMyPortalModelRO

All Superinterfaces:
IModelRO, IMVCObject
All Known Subinterfaces:
IMyPortalModel
All Known Implementing Classes:
MyPortalModel

public interface IMyPortalModelRO
extends IModelRO

Model interface used by plugin navigation

Author:
MichaelD, DavidP

Method Summary
 java.lang.Object[][] GetCollapsedOrErrorContent(int nPortletIndex)
          Returns the markup which should be displayed in case of a collapsed or error portlet.
 int GetCommunityID()
          Get the community ID of the community we are currently viewing.
 java.lang.String GetCommunityName()
          Get the name of the community we are currently viewing.
 IPTQueryResult GetCommunityPages()
          Get the pages in the community.
 boolean GetDisplayPortletHeaderDueToError(int nPortletIndex)
          If there was an error, display the gadget header regardless of any other settings.
 int GetFirstPortletIndexInColumn(int nPortletColumn)
          Get the first gadget index in the given column.
 IMyPortalModelHelper GetHelper()
          Get the helper object for this model.
 java.lang.String GetIDStringForPortlet(int nPortletIndex)
          Get the gadget ID string from the given index.
 boolean GetIsCommunityPage()
          Get whether the current page is a community page.
 int GetLastPortletIndexInColumn(int nPortletColumn)
          Get the last gadget index in the given column.
 ASURL GetPageASURL()
          Get the ASURL for the page we are on.
 int GetPageID()
          Get the page ID of the page we are currently viewing.
 java.lang.String GetPageName()
          Get the name of the page we are currently viewing.
 int GetPageType()
          Get the page type of the page we are currently viewing.
 java.lang.String GetPortletAdminPrefsURL(int nPortletIndex)
          Get the gadget Admin Preference URL at the given index.
 boolean GetPortletCollapsed(int nPortletIndex)
          Get the whether the gadget at the given index is collapsed.
 java.lang.String GetPortletCollapseExpandURL(int nPortletIndex, java.lang.String strControl)
          Get the gadget Collapse/Expand URL at the given index.
 int GetPortletColumnFromIndex(int nPortletIndex)
          Get the gadget column from the given index.
 java.lang.String GetPortletCommunityPrefsURL(int nPortletIndex)
          Get the gadget Community Preference URL at the given index.
 int GetPortletCount()
          Get the number of gadgets on the page we are currently viewing.
 java.lang.String GetPortletDisabledMessage(int nPortletIndex)
          Get the gadget's disabled message from the given index.
 boolean GetPortletEnabled(int nPortletIndex)
          Get the whether the gadget at the given index is enabled.
 boolean GetPortletHasAdminPrefsURL(int nPortletIndex)
          Get whether the gadget at the given index has a Admin Preference URL.
 boolean GetPortletHasCollapseExpandURL(int nPortletIndex)
          Get whether the gadget at the given index has a Collapse/Expand URL.
 boolean GetPortletHasCommunityPrefsURL(int nPortletIndex)
          Get whether the gadget at the given index has a Community Preference URL.
 boolean GetPortletHasHelpURL(int nPortletIndex)
          Get whether the gadget at the given index has a help URL.
 boolean GetPortletHasRefreshButton(int nPortletIndex)
          Returns whether the portlet at a given index has a Refresh button.
 boolean GetPortletHasTitleBar(int nPortletIndex)
          Get whether a gadget has a title bar or not.
 boolean GetPortletHasUserPrefsURL(int nPortletIndex)
          Get whether the gadget at the given index has a User Preference URL.
 java.lang.String GetPortletHelpURL(int nPortletIndex)
          Get the gadget help URL at the given index.
 java.lang.Object[][] GetPortletHTMLTextFromIndex(int nGadgetIndex)
          Get the gadget content from the given index.
 int GetPortletIDFromIndex(int nPortletIndex)
          Get the gadget ID from the given index.
 boolean GetPortletIsMandatory(int nPortletIndex)
          Get the whether the gadget at the given index is mandatory.
 int GetPortletLayoutId()
           
 java.lang.String GetPortletNameFromIndex(int nPortletColumn)
          Get the gadget name from the given index.
 java.lang.String GetPortletPrefButtonBoolean()
          Get the PortletPrefButton boolean from the varpack.
 IXPList GetPortletPreferenceActionsData(int nPortletIndex)
          Get the portlet pref actions.
 java.lang.String GetPortletRemoveURL(int nPortletIndex)
          Get the gadget Remove URL at the given index.
 boolean GetPortletSupports508(int nPortletIndex)
          Returns whether or not the gadget supports 508 mode
 int GetPortletSupportsPersonalization(int nPortletIndex)
          Returns a bitmask of the types of personalization this portlet supports.
 java.lang.String GetPortletUserPrefsURL(int nPortletIndex)
          Get the gadget User Preference URL at the given index.
 java.lang.String GetPortletUUID(int nPortletIndex)
          Get the UUID of the portlet.
 int GetProfileID()
          Get the profile ID of the user being viewed on the user profile community.
 XPArrayList GetRecentlyAddedPortlets()
          Returns the id of the portlet that was recently added to the page
 int GetRecentlyCollapsedExpandedPortlet()
          Returns the id of the portlet that was recently collapsed from the page
 int GetRecentlyRemovedPortlet()
          Returns the id of the portlet that was recently removed from the page
 IPTSession GetSession()
          Get the current IPTSession.
 void SetDisplayPortletHeaderDueToError(int nPortletIndex, boolean bDisplayHeader)
          If there was an error, display the gadget header regardless of any other settings.
 boolean UsesPortletLayout()
          If the current page has an adaptive Portlet Layout set.
 
Methods inherited from interface com.plumtree.uiinfrastructure.activityspace.IMVCObject
GetName
 

Method Detail

GetCommunityID

int GetCommunityID()
Get the community ID of the community we are currently viewing.

Returns:
int nCommunityID

GetCommunityName

java.lang.String GetCommunityName()
Get the name of the community we are currently viewing.

Returns:
string

GetCommunityPages

IPTQueryResult GetCommunityPages()
Get the pages in the community.

Returns:
IPTQueryResult ptqrCommunityPages

GetFirstPortletIndexInColumn

int GetFirstPortletIndexInColumn(int nPortletColumn)
Get the first gadget index in the given column.

Parameters:
nPortletColumn - nPortletColumn
Returns:
int nPortletIndex

GetPortletCollapsed

boolean GetPortletCollapsed(int nPortletIndex)
Get the whether the gadget at the given index is collapsed.

Parameters:
nPortletIndex - nPortletIndex
Returns:
boolean bPortletCollapsed

GetPortletColumnFromIndex

int GetPortletColumnFromIndex(int nPortletIndex)
Get the gadget column from the given index.

Parameters:
nPortletIndex - nPortletIndex
Returns:
int nPortletColumn

GetPortletCount

int GetPortletCount()
Get the number of gadgets on the page we are currently viewing.

Returns:
int nPortletCount

GetPortletDisabledMessage

java.lang.String GetPortletDisabledMessage(int nPortletIndex)
Get the gadget's disabled message from the given index.

Parameters:
nPortletIndex - nPortletIndex
Returns:
String strPortletDisabledMessage

GetPortletEnabled

boolean GetPortletEnabled(int nPortletIndex)
Get the whether the gadget at the given index is enabled.

Parameters:
nPortletIndex - nPortletIndex
Returns:
boolean bPortletEnabled

GetDisplayPortletHeaderDueToError

boolean GetDisplayPortletHeaderDueToError(int nPortletIndex)
If there was an error, display the gadget header regardless of any other settings.

Parameters:
nPortletIndex - nPortletIndex
Returns:
boolean bDisplayHeader

SetDisplayPortletHeaderDueToError

void SetDisplayPortletHeaderDueToError(int nPortletIndex,
                                       boolean bDisplayHeader)
If there was an error, display the gadget header regardless of any other settings.

Parameters:
nPortletIndex - nPortletIndex

GetPortletHTMLTextFromIndex

java.lang.Object[][] GetPortletHTMLTextFromIndex(int nGadgetIndex)
Get the gadget content from the given index.

Parameters:
nPortletIndex - nPortletIndex
Returns:
String strPortletHTMLText

GetPortletHasHelpURL

boolean GetPortletHasHelpURL(int nPortletIndex)
Get whether the gadget at the given index has a help URL.

Parameters:
nPortletIndex - nPortletIndex
Returns:
boolean bPortletHasHelpURL

GetPortletHasAdminPrefsURL

boolean GetPortletHasAdminPrefsURL(int nPortletIndex)
Get whether the gadget at the given index has a Admin Preference URL.

Parameters:
nPortletIndex - nPortletIndex
Returns:
boolean bPortletHasAdminPrefsURL

GetPortletHasCommunityPrefsURL

boolean GetPortletHasCommunityPrefsURL(int nPortletIndex)
Get whether the gadget at the given index has a Community Preference URL.

Parameters:
nPortletIndex - nPortletIndex
Returns:
boolean bPortletHasCommunityPrefsURL

GetPortletHasUserPrefsURL

boolean GetPortletHasUserPrefsURL(int nPortletIndex)
Get whether the gadget at the given index has a User Preference URL.

Parameters:
nPortletIndex - nPortletIndex
Returns:
boolean bPortletHasUserPrefsURL

GetPortletHasCollapseExpandURL

boolean GetPortletHasCollapseExpandURL(int nPortletIndex)
Get whether the gadget at the given index has a Collapse/Expand URL.

Parameters:
nPortletIndex - nPortletIndex
Returns:
boolean bPortletHasCollapseExpandURL

GetPortletUUID

java.lang.String GetPortletUUID(int nPortletIndex)
Get the UUID of the portlet.

Parameters:
nPortletIndex - nPortletIndex
Returns:
String strUUID

GetPortletHasTitleBar

boolean GetPortletHasTitleBar(int nPortletIndex)
Get whether a gadget has a title bar or not.

Parameters:
nPortletIndex - nPortletIndex
Returns:
boolean bPortletHasTitleBar

GetPortletHelpURL

java.lang.String GetPortletHelpURL(int nPortletIndex)
Get the gadget help URL at the given index.

Parameters:
nPortletIndex - nPortletIndex
Returns:
String strPortletHelpURL

GetPortletAdminPrefsURL

java.lang.String GetPortletAdminPrefsURL(int nPortletIndex)
Get the gadget Admin Preference URL at the given index.

Parameters:
nPortletIndex - nPortletIndex
Returns:
String strPortletAdminPrefsURL

GetPortletCommunityPrefsURL

java.lang.String GetPortletCommunityPrefsURL(int nPortletIndex)
Get the gadget Community Preference URL at the given index.

Parameters:
nPortletIndex - nPortletIndex
Returns:
String strPortletCommunityPrefsURL

GetPortletUserPrefsURL

java.lang.String GetPortletUserPrefsURL(int nPortletIndex)
Get the gadget User Preference URL at the given index.

Parameters:
nPortletIndex - nPortletIndex
Returns:
String strPortletUserPrefsURL

GetPortletCollapseExpandURL

java.lang.String GetPortletCollapseExpandURL(int nPortletIndex,
                                             java.lang.String strControl)
Get the gadget Collapse/Expand URL at the given index.

Parameters:
nPortletIndex - nPortletIndex
strControl - strControl
Returns:
String strPortletCollapseExpandURL

GetPortletRemoveURL

java.lang.String GetPortletRemoveURL(int nPortletIndex)
Get the gadget Remove URL at the given index.

Parameters:
nPortletIndex -
Returns:
String strPortletRemoveURL

GetPortletIDFromIndex

int GetPortletIDFromIndex(int nPortletIndex)
Get the gadget ID from the given index.

Parameters:
nPortletIndex - nPortletIndex
Returns:
int nPortletID

GetPortletIsMandatory

boolean GetPortletIsMandatory(int nPortletIndex)
Get the whether the gadget at the given index is mandatory.

Parameters:
nPortletIndex - nPortletIndex
Returns:
boolean bPortletIsMandatory

GetPortletNameFromIndex

java.lang.String GetPortletNameFromIndex(int nPortletColumn)
Get the gadget name from the given index.

Parameters:
nPortletColumn - nPortletIndex
Returns:
String strPortletName

GetIDStringForPortlet

java.lang.String GetIDStringForPortlet(int nPortletIndex)
Get the gadget ID string from the given index.

Parameters:
nPortletIndex - nPortletIndex
Returns:
String strPortletID

GetPortletSupports508

boolean GetPortletSupports508(int nPortletIndex)
Returns whether or not the gadget supports 508 mode


GetPortletSupportsPersonalization

int GetPortletSupportsPersonalization(int nPortletIndex)
Returns a bitmask of the types of personalization this portlet supports.


GetHelper

IMyPortalModelHelper GetHelper()
Get the helper object for this model.

Returns:
IMyPortalModelHelper

GetIsCommunityPage

boolean GetIsCommunityPage()
Get whether the current page is a community page.

Returns:
boolean bIsCommunityPage

GetLastPortletIndexInColumn

int GetLastPortletIndexInColumn(int nPortletColumn)
Get the last gadget index in the given column.

Parameters:
nPortletColumn - nPortletColumn
Returns:
int nPortletIndex

GetPageASURL

ASURL GetPageASURL()
Get the ASURL for the page we are on.

Returns:
ASURL asurlPage

GetPageID

int GetPageID()
Get the page ID of the page we are currently viewing.

Returns:
int nPageID

GetPageName

java.lang.String GetPageName()
Get the name of the page we are currently viewing.

Returns:
string

GetPageType

int GetPageType()
Get the page type of the page we are currently viewing.

Returns:
int nPageType

GetPortletLayoutId

int GetPortletLayoutId()
Returns:
The Portlet Layout Webservice Id, or 0 if none is set on this page.

UsesPortletLayout

boolean UsesPortletLayout()
If the current page has an adaptive Portlet Layout set.

Returns:

GetSession

IPTSession GetSession()
Get the current IPTSession. This method should only be used by MyPortalModel.

Returns:
int nPageID

GetPortletPrefButtonBoolean

java.lang.String GetPortletPrefButtonBoolean()
Get the PortletPrefButton boolean from the varpack.

Returns:
string

GetPortletHasRefreshButton

boolean GetPortletHasRefreshButton(int nPortletIndex)
Returns whether the portlet at a given index has a Refresh button.

Parameters:
nPortletIndex - nPortletIndex
Returns:
boolean bPortletHasRefreshButton

GetCollapsedOrErrorContent

java.lang.Object[][] GetCollapsedOrErrorContent(int nPortletIndex)
Returns the markup which should be displayed in case of a collapsed or error portlet.

Parameters:
nPortletIndex -
Returns:
object markup array

GetRecentlyAddedPortlets

XPArrayList GetRecentlyAddedPortlets()
Returns the id of the portlet that was recently added to the page

Returns:
a list of the portlets that were recently added to the page.

GetRecentlyRemovedPortlet

int GetRecentlyRemovedPortlet()
Returns the id of the portlet that was recently removed from the page

Returns:
id of portlet

GetRecentlyCollapsedExpandedPortlet

int GetRecentlyCollapsedExpandedPortlet()
Returns the id of the portlet that was recently collapsed from the page

Returns:
id of portlet

GetProfileID

int GetProfileID()
Get the profile ID of the user being viewed on the user profile community.

Returns:
the user ID of the profile being viewed, 0 if not used.

GetPortletPreferenceActionsData

IXPList GetPortletPreferenceActionsData(int nPortletIndex)
Get the portlet pref actions.

Parameters:
nPortletIndex -
Returns:
list of FullURLs



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