com.plumtree.portalpages.browsing.portletpreview
Interface IPreviewPortletModelRO

All Superinterfaces:

IModelRO, IMVCObject

All Known Implementing Classes:

PreviewPortletModel

public interface IPreviewPortletModelRO
extends IModelRO

File: IPreviewPortletModelRO --------------------------- Read Only Interface for the PreviewPortletModel.

Author:

NaveenP/DustinA, DavidP

Method Summary

void	AddPortletInPage() AddPortletInPage - adds gadget to the specified user's page
java.lang.String	GetAddPortletJavaScriptOverride() Get Add Portlet Javascript override.
XPArrayList	GetAllCommunitiesUsingPortlet() List of Communities Containing This Portlet
boolean	GetAlwaysUseCommunityPreview() Returns true if the community preview mode should be used even if the portlet is not community-only
java.lang.String	GetDefaultMyPageURL() Get Default MyPage URL
IASQueryResult	GetMyPages() Get My Pages
java.lang.String	GetMyPageURL() Get MyPage URL
int	GetPageID() Get the page id
java.lang.String	GetPageName() Get the page name
int	GetPortletAlignment() Get the gadget alignment
java.lang.String	GetPortletDescription() Get the gadget name
java.lang.String	GetPortletDisabledMessage() Get Disabled Message if portlet is disabled
java.lang.Object[][]	GetPortletHTMLText() Get the gadget HTML Text
int	GetPortletID() Get the gadget id
int	GetPortletIndex() Get the gadget index for selection page
java.lang.String	GetPortletName() Get the gadget name
java.lang.String	GetPortletPreviewURL() Get Preview Portlet URL
int	GetPortletType() Returns the gadget type
IPTSession	GetSession() Returns the user session
int	GetUserID() Returns the user ID
boolean	IsErrorPage() IsErrorPage
boolean	IsNarrow() Is Portlet Narrow
boolean	IsPortletChecked() Is Portlet Checked
boolean	IsPortletEnabled() Is Portlet Enabled
boolean	IsPortletInPage() IsPortletInPage - checks to if the gadget is already in the user's page thatt's specified
boolean	IsPortletInvitePage() Is Portlet Invite Page
boolean	IsPortletSearchPreviewPage() Is Search Preview Portlet
boolean	IsPortletSelectionPreviewPage() Is Portlet Selection Preview Page
boolean	UserHasMyPageAccess() User Has My Page Access
boolean	UserHasReadAccess() User Has Read Access
boolean	UserHasSelectAccess() User Has Select Access

Methods inherited from interface com.plumtree.uiinfrastructure.activityspace.IMVCObject

GetName

Method Detail

AddPortletInPage

void AddPortletInPage()

AddPortletInPage - adds gadget to the specified user's page

Parameters:

int - nPageID

GetDefaultMyPageURL

java.lang.String GetDefaultMyPageURL()

Get Default MyPage URL

Returns:

String

GetPortletAlignment

int GetPortletAlignment()

Get the gadget alignment

Returns:

String

GetPortletHTMLText

java.lang.Object[][] GetPortletHTMLText()

Get the gadget HTML Text

Returns:

String

GetPortletID

int GetPortletID()

Get the gadget id

Returns:

int

GetPortletIndex

int GetPortletIndex()

Get the gadget index for selection page

Returns:

int

GetPortletName

java.lang.String GetPortletName()

Get the gadget name

Returns:

String

GetPortletDescription

java.lang.String GetPortletDescription()

Get the gadget name

Returns:

String

GetPortletPreviewURL

java.lang.String GetPortletPreviewURL()

Get Preview Portlet URL

Returns:

String

GetPortletType

int GetPortletType()

Returns the gadget type

Returns:

Portlet type

GetAlwaysUseCommunityPreview

boolean GetAlwaysUseCommunityPreview()

Returns true if the community preview mode should be used even if the portlet is not community-only

Returns:

True if the community preview mode should be used even if the portlet is not community-only

GetMyPageURL

java.lang.String GetMyPageURL()

Get MyPage URL

Returns:

String

GetMyPages

IASQueryResult GetMyPages()

Get My Pages

Returns:

boolean

GetPageID

int GetPageID()

Get the page id

Returns:

int

GetPageName

java.lang.String GetPageName()

Get the page name

Returns:

String

GetSession

IPTSession GetSession()

Returns the user session

Returns:

IPTSession

GetUserID

int GetUserID()

Returns the user ID

Returns:

User ID

IsErrorPage

boolean IsErrorPage()

IsErrorPage

Parameters:

boolean -

IsPortletChecked

boolean IsPortletChecked()

Is Portlet Checked

Returns:

boolean

IsPortletInPage

boolean IsPortletInPage()

IsPortletInPage - checks to if the gadget is already in the user's page thatt's specified

Parameters:

int - nPageID

IsPortletInvitePage

boolean IsPortletInvitePage()

Is Portlet Invite Page

Returns:

boolean

IsPortletSearchPreviewPage

boolean IsPortletSearchPreviewPage()

Is Search Preview Portlet

Returns:

boolean

IsPortletSelectionPreviewPage

boolean IsPortletSelectionPreviewPage()

Is Portlet Selection Preview Page

Returns:

boolean

IsNarrow

boolean IsNarrow()

Is Portlet Narrow

Returns:

boolean

UserHasReadAccess

boolean UserHasReadAccess()

User Has Read Access

Returns:

boolean

UserHasSelectAccess

boolean UserHasSelectAccess()

User Has Select Access

Returns:

boolean

UserHasMyPageAccess

boolean UserHasMyPageAccess()

User Has My Page Access

Returns:

boolean

GetAllCommunitiesUsingPortlet

XPArrayList GetAllCommunitiesUsingPortlet()

List of Communities Containing This Portlet

Returns:

boolean

IsPortletEnabled

boolean IsPortletEnabled()

Is Portlet Enabled

Returns:

boolean

GetPortletDisabledMessage

java.lang.String GetPortletDisabledMessage()

Get Disabled Message if portlet is disabled

Returns:

String

GetAddPortletJavaScriptOverride

java.lang.String GetAddPortletJavaScriptOverride()

Get Add Portlet Javascript override. This javascript should be the name of the javascript function to be used in the onclick attribute of the add button. The function should take 2 arguments: the portlet ID, and a reference to the popup window. (i.e. If the name is "addPortlet", then the function will look like this: "addPortlet(portletID, self)"). This function name can also include an optional window reference (i.e. "opener.addPortlet").

Returns:

String the name of the javascript function to use when adding the portlet. This string will be null if there is no override.