com.plumtree.server
Interface IPTMyPortal

All Superinterfaces:

IPTUnknown

Deprecated. Interface IPTMyPortal is deprecated. Use IPTPageInfo or IPTPage instead.

public interface IPTMyPortal
extends IPTUnknown

IPTMyPortal

Author:

Self-Service Communities, Michael DeCourcey

Method Summary

void	AddCommunitySetting(java.lang.String strCommunitySetting, double dValue) Deprecated.
void	AddCommunitySetting(java.lang.String strCommunitySetting, int nValue) Deprecated.
void	AddCommunitySetting(java.lang.String strCommunitySetting, java.lang.Object objValue) Deprecated.
void	AddCommunitySetting(java.lang.String strCommunitySetting, java.lang.String strValue) Deprecated.
void	AddCommunitySetting(java.lang.String strCommunitySetting, com.plumtree.openfoundation.util.XPDateTime dtValue) Deprecated.
void	AddGadget(int nGadgetID) Deprecated.
void	AddGadgetEx(int nGadgetID, int nColumnID) Deprecated.
void	AddPersonalSetting(java.lang.String strPersonalSetting, double dValue) Deprecated.
void	AddPersonalSetting(java.lang.String strPersonalSetting, int nValue) Deprecated.
void	AddPersonalSetting(java.lang.String strPersonalSetting, java.lang.Object objValue) Deprecated.
void	AddPersonalSetting(java.lang.String strPersonalSetting, java.lang.String strValue) Deprecated.
void	AddPersonalSetting(java.lang.String strPersonalSetting, com.plumtree.openfoundation.util.XPDateTime dtValue) Deprecated.
void	AddSessionPreference(java.lang.String strSessionPreference, java.lang.String strValue) Deprecated.
void	AssignCommunityGadgetSettings(int nGadgetID, java.lang.Object[][] arrSettings) Deprecated.
void	AssignCommunityGadgetSettingsEx(int nGadgetID, java.lang.Object[][] arrSettings, boolean bDeletePrefs) Deprecated.
void	AssignGadgetSettings(int nGadgetID, java.lang.Object[][] arrSettings) Deprecated.
void	AssignGadgetSettingsEx(int nGadgetID, java.lang.Object[][] arrSettings, boolean bDeletePrefs) Deprecated.
void	AssignGadgetsEx(int[] arrGadgetIDs, int nColumnID) Deprecated.
void	AssignGadgetsEx(int nGadgetID, int nColumnID) Deprecated.
int	GetCommunityID() Deprecated.
java.lang.String	GetCommunityName() Deprecated.
int	GetPageID() Deprecated.
java.lang.String	GetPageName() Deprecated.
int	GetPageType() Deprecated.
java.lang.String	GetURL() Deprecated. - This function should not be called.
java.lang.Object[][]	LookupCommunityGadgetSettings(int nGadgetID, java.lang.Object arrSettings) Deprecated.
java.lang.Object[][]	LookupCommunityGadgetSettings(int nGadgetID, java.lang.String strSetting) Deprecated.
java.lang.Object[][]	LookupCommunityGadgetSettings(int nGadgetID, java.lang.String[] arrSettings) Deprecated.
java.lang.Object[][]	LookupCommunitySettings(java.lang.Object arrSettings) Deprecated.
java.lang.Object[][]	LookupCommunitySettings(java.lang.String strSetting) Deprecated.
java.lang.Object[][]	LookupCommunitySettings(java.lang.String[] arrSettings) Deprecated.
java.lang.Object[][]	LookupGadgetSettings(int nGadgetID, java.lang.Object arrSettings) Deprecated.
java.lang.Object[][]	LookupGadgetSettings(int nGadgetID, java.lang.String strSetting) Deprecated.
java.lang.Object[][]	LookupGadgetSettings(int nGadgetID, java.lang.String[] arrSettings) Deprecated.
java.lang.Object[][]	LookupPersonalSettings(java.lang.Object arrSettings) Deprecated.
java.lang.Object[][]	LookupPersonalSettings(java.lang.String strSetting) Deprecated.
java.lang.Object[][]	LookupPersonalSettings(java.lang.String[] arrSettings) Deprecated.
java.lang.String[][]	LookupSessionPreference(java.lang.String strSessionPreferenceName) Deprecated.
java.lang.String[][]	LookupSessionPreferences(java.lang.String[] astrPreferenceNames) Deprecated.
IPTMyPortalGadgetContent	QueryGadgetContent(java.lang.Object objAppDataStateObject, java.lang.String strUserInterfaceID, int nMode, boolean bReturnAllGadgets) Deprecated. Use IPTPageInfo.QueryPortletContent instead. If you are not on a Community Page or My Page, then use the IPTPageInfo for the Global Page: PT_INTRINSICS.PT_PAGE_GLOBAL.
IPTQueryResult	QueryGadgets() Deprecated.
void	RemoveCommunityGadgetSetting(int nGadgetID, java.lang.String strCommunitySetting) Deprecated.
void	RemoveCommunitySetting(java.lang.String strCommunitySetting) Deprecated.
void	RemoveGadget(int nGadgetID) Deprecated.
void	RemoveGadgetSetting(int nGadgetID, java.lang.String strSetting) Deprecated.
void	RemovePersonalSetting(java.lang.String strPersonalSetting) Deprecated.
void	RemoveSessionPreference(java.lang.String strSessionPreference) Deprecated.

Methods inherited from interface com.plumtree.server.IPTUnknown

GetInterfaces

Method Detail

GetCommunityID

int GetCommunityID()

Deprecated.

Get the community id of the community that the current page is part of. Returns 0 if the current page is a my page.

Returns:

int - community id

GetCommunityName

java.lang.String GetCommunityName()

Deprecated.

Get the community name of the community that the current page is part of. Returns empty string the current page is a my page.

Returns:

String - community name

QueryGadgets

IPTQueryResult QueryGadgets()

Deprecated.

Query for all the gadgets on the page that this IPTMyPortal represents.

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

AddGadget

void AddGadget(int nGadgetID)

Deprecated.

Add one gadget to the page that this IPTMyPortal represents. This is a legacy method, so AddGadgetEx should be used instead.

Parameters:

nGadgetID - - gadget id of the gadget to add

RemoveGadget

void RemoveGadget(int nGadgetID)

Deprecated.

Remove one gadget from the page that this IPTMyPortal represents.

Parameters:

nGadgetID - - gadget id of the gadget to remove

QueryGadgetContent

IPTMyPortalGadgetContent QueryGadgetContent(java.lang.Object objAppDataStateObject,
                                            java.lang.String strUserInterfaceID,
                                            int nMode,
                                            boolean bReturnAllGadgets)

Deprecated. Use IPTPageInfo.QueryPortletContent instead. If you are not on a Community Page or My Page, then use the IPTPageInfo for the Global Page: PT_INTRINSICS.PT_PAGE_GLOBAL.

Query for the all of the gadget content on the page that this IPTMyPortal represents.

Parameters:

objAppDataStateObject - - Application data state object for this page (and community, if relevant)

strUserInterfaceID - - User interface id that needs to be supported ("" for all gadgets, "http://www.plumtree.com/uis/section508" for 508 compliant gadgets, etc.)

nMode - - gadget mode (see PT_GADGET_MODES)

bReturnAllGadgets - - boolean to return all gadgets regardless of interface

Returns:

IPTMyPortalGadgetContent - content of the all the gadgets returned

GetPageID

int GetPageID()

Deprecated.

Get the Page ID of the page that this IPTMyPortal represents.

Returns:

int - the page id

GetPageName

java.lang.String GetPageName()

Deprecated.

Get the Page name of the page that this IPTMyPortal represents.

Returns:

String - the page name

GetURL

java.lang.String GetURL()

Deprecated. - This function should not be called.

Get the URL (page type) of the page that this IPTMyPortal represents. Throws an exception if the current page is a my page. This function will be removed.

Returns:

String

GetPageType

int GetPageType()

Deprecated.

Get the type of the page that this IPTMyPortal represents.

Returns:

int - the type, of which constants are defined in the UI

AssignGadgetsEx

void AssignGadgetsEx(int[] arrGadgetIDs,
                     int nColumnID)

Deprecated.

Assign a list of gadgets to a column on the page that this IPTMyPortal represents. It adds this list to the gadgets that are already in this column.

Parameters:

arrGadgetIDs - - array of gadget ids that are to be added

nColumnID - - column id in which to place all the gadgets

AssignGadgetsEx

void AssignGadgetsEx(int nGadgetID,
                     int nColumnID)

Deprecated.

Assign a gadget to a column on the page that this IPTMyPortal represents. It adds this gadget to the gadgets that are already in this column.

Parameters:

nGadgetID - - gadget id that is to be added

nColumnID - - column id in which to place the gadget

AddGadgetEx

void AddGadgetEx(int nGadgetID,
                 int nColumnID)

Deprecated.

Add a gadget to a column on the page that this IPTMyPortal represents. It adds this gadget to the gadgets that are already in this column.

Parameters:

nGadgetID - - gadget id that is to be added

nColumnID - - column id in which to place the gadget

LookupGadgetSettings

java.lang.Object[][] LookupGadgetSettings(int nGadgetID,
                                          java.lang.String[] arrSettings)

Deprecated.

Look up a list of user-gadget settings (preferences) for the combination of a particular gadget and the current user.

Parameters:

nGadgetID - - gadget id of the gadget whose settings are desired

arrSettings - - array of setting names that are desired

Returns:

Object[][] - array of names and corresponding values Object[name(0) or value{1)][index]

LookupGadgetSettings

java.lang.Object[][] LookupGadgetSettings(int nGadgetID,
                                          java.lang.String strSetting)

Deprecated.

Look up one user-gadget setting (preference) for the combination of a particular gadget and the current user.

Parameters:

nGadgetID - - gadget id of the gadget whose settings are desired

strSetting - - setting name that is desired

Returns:

Object[][] - array of name and corresponding value Object[0][0] = setting name Object[1][0] = setting value

LookupGadgetSettings

java.lang.Object[][] LookupGadgetSettings(int nGadgetID,
                                          java.lang.Object arrSettings)

Deprecated.

Look up a list of user-gadget settings (preferences) for the combination of a particular gadget and the current user.

Parameters:

nGadgetID - - gadget id of the gadget whose settings are desired

arrSettings - - array of setting names that are desired

Returns:

Object[][] - array of names and corresponding values Object[name(0) or value{1)][index] This function is being considered for removal.

AssignGadgetSettings

void AssignGadgetSettings(int nGadgetID,
                          java.lang.Object[][] arrSettings)

Deprecated.

Assign a list of user-gadget settings (preferences) to the combination of a particular gadget and the current user. Calling this function will delete all the old settings for this gadget and user.

Parameters:

nGadgetID - - gadget id of the gadget whose settings are to be changed.

arrSettings - - array of names and corresponding values to be set on the gadget. Object[name(0) or value(1)][index]

AssignGadgetSettingsEx

void AssignGadgetSettingsEx(int nGadgetID,
                            java.lang.Object[][] arrSettings,
                            boolean bDeletePrefs)

Deprecated.

Assign a list of user-gadget settings (preferences) to the combination of a particular gadget and the current user.

Parameters:

nGadgetID - - gadget id of the gadget whose settings are to be changed.

arrSettings - - array of names and corresponding values to be set on the gadget. Object[name(0) or value(1)][index]

bDeletePrefs - - boolean that will delete the old settings for this user-gadget combination or append the new list to the old settings

RemoveGadgetSetting

void RemoveGadgetSetting(int nGadgetID,
                         java.lang.String strSetting)

Deprecated.

Remove a user-gadget setting (preference) for the combination of a particular gadget and the current user.

Parameters:

nGadgetID - - gadget id of the gadget whose setting is to be removed

strSetting - - name of the setting to be removed

LookupPersonalSettings

java.lang.Object[][] LookupPersonalSettings(java.lang.String[] arrSettings)

Deprecated.

Look up a list of personal settings (preferences) for the current user.

Parameters:

arrSettings - - array of setting names that are desired

Returns:

Object[][] - array of names and corresponding values Object[name(0) or value(1)][index]

LookupPersonalSettings

java.lang.Object[][] LookupPersonalSettings(java.lang.String strSetting)

Deprecated.

Look up one personal setting (preference) for the current user.

Parameters:

strSetting - - setting name that is desired

Returns:

Object[][] - array of name and corresponding value Object[0][0] = setting name Object[1][0] = setting value

LookupPersonalSettings

java.lang.Object[][] LookupPersonalSettings(java.lang.Object arrSettings)

Deprecated.

Look up a list of personal settings (preferences) for the current user.

Parameters:

arrSettings - - array of setting names that are desired

Returns:

Object[][] - array of names and corresponding values Object[name(0) or value(1)][index] This function is being considered for removal.

AddPersonalSetting

void AddPersonalSetting(java.lang.String strPersonalSetting,
                        int nValue)

Deprecated.

Add a personal setting (preference) for the current user.

Parameters:

strPersonalSetting - - name of the setting

nValue - - int value of the setting

AddPersonalSetting

void AddPersonalSetting(java.lang.String strPersonalSetting,
                        java.lang.String strValue)

Deprecated.

Add a personal setting (preference) for the current user.

Parameters:

strPersonalSetting - - name of the setting

strValue - - string value of the setting

AddPersonalSetting

void AddPersonalSetting(java.lang.String strPersonalSetting,
                        com.plumtree.openfoundation.util.XPDateTime dtValue)

Deprecated.

Add a personal setting (preference) for the current user.

Parameters:

strPersonalSetting - - name of the setting

dtValue - - XPDateTime value of the setting

AddPersonalSetting

void AddPersonalSetting(java.lang.String strPersonalSetting,
                        double dValue)

Deprecated.

Add a personal setting (preference) for the current user.

Parameters:

strPersonalSetting - - name of the setting

dValue - - double value of the setting

AddPersonalSetting

void AddPersonalSetting(java.lang.String strPersonalSetting,
                        java.lang.Object objValue)

Deprecated.

Add a personal setting (preference) for the current user.

Parameters:

strPersonalSetting - - name of the setting

objValue - - object value of the setting This function is being considered for removal.

RemovePersonalSetting

void RemovePersonalSetting(java.lang.String strPersonalSetting)

Deprecated.

Remove a personal setting (preference) for the current user.

Parameters:

strPersonalSetting - - name of the setting to be removed

LookupCommunitySettings

java.lang.Object[][] LookupCommunitySettings(java.lang.String[] arrSettings)

Deprecated.

Look up community settings (preferences) for the community that the current page is part of. Throws an exception if the current page is a my page.

Parameters:

arrSettings - - array of setting names that are desired

Returns:

Object[][] - array of names and corresponding values Object[name(0) or value{1)][index]

LookupCommunitySettings

java.lang.Object[][] LookupCommunitySettings(java.lang.String strSetting)

Deprecated.

Look up one community setting (preference) for the community that the current page is part of. Throws an exception if the current page is a my page.

Parameters:

strSetting - - setting name that is desired

Returns:

Object[][] - array of name and corresponding value Object[0][0] = setting name Object[1][0] = setting value

LookupCommunitySettings

java.lang.Object[][] LookupCommunitySettings(java.lang.Object arrSettings)

Deprecated.

Look up community settings (preferences) for the community that the current page is part of. Throws an exception if the current page is a my page.

Parameters:

arrSettings - - array of setting names that are desired

Returns:

Object[][] - array of names and corresponding values Object[name(0) or value{1)][index] This function is being considered for removal.

AddCommunitySetting

void AddCommunitySetting(java.lang.String strCommunitySetting,
                         int nValue)

Deprecated.

Add a community setting (preference) to the community that the current page is part of. Throws an exception if the current page is a my page.

Parameters:

strCommunitySetting - - name of the setting

nValue - - int value of the setting

AddCommunitySetting

void AddCommunitySetting(java.lang.String strCommunitySetting,
                         java.lang.String strValue)

Deprecated.

Add a community setting (preference) to the community that the current page is part of. Throws an exception if the current page is a my page.

Parameters:

strCommunitySetting - - name of the setting

strValue - - string value of the setting

AddCommunitySetting

void AddCommunitySetting(java.lang.String strCommunitySetting,
                         com.plumtree.openfoundation.util.XPDateTime dtValue)

Deprecated.

Add a community setting (preference) to the community that the current page is part of. Throws an exception if the current page is a my page.

Parameters:

strCommunitySetting - - name of the setting

dtValue - - XPDateTime value of the setting

AddCommunitySetting

void AddCommunitySetting(java.lang.String strCommunitySetting,
                         double dValue)

Deprecated.

Add a community setting (preference) to the community that the current page is part of. Throws an exception if the current page is a my page.

Parameters:

strCommunitySetting - - name of the setting

dValue - - double value of the setting

AddCommunitySetting

void AddCommunitySetting(java.lang.String strCommunitySetting,
                         java.lang.Object objValue)

Deprecated.

Add a community setting (preference) to the community that the current page is part of. Throws an exception if the current page is a my page.

Parameters:

strCommunitySetting - - name of the setting

objValue - - object value of the setting This function is being considered for removal.

RemoveCommunitySetting

void RemoveCommunitySetting(java.lang.String strCommunitySetting)

Deprecated.

Remove a community setting (preference) for the community that the current page is part of. Throws an exception if the current page is a my page.

Parameters:

strCommunitySetting - - name of the setting to be removed

LookupCommunityGadgetSettings

java.lang.Object[][] LookupCommunityGadgetSettings(int nGadgetID,
                                                   java.lang.String[] arrSettings)

Deprecated.

Look up community-gadget settings (preferences) for the combination of the community that the current page is part of and the gadget id that is passed in. Throws an exception if the current page is a my page.

Parameters:

nGadgetID - - gadget id of the gadget whose settings are desired

arrSettings - - array of setting names that are desired

Returns:

Object[][] - array of names and corresponding values Object[name(0) or value{1)][index]

LookupCommunityGadgetSettings

java.lang.Object[][] LookupCommunityGadgetSettings(int nGadgetID,
                                                   java.lang.String strSetting)

Deprecated.

Look up a community-gadget setting (preference) for the combination of the community that the current page is part of and the gadget id that is passed in. Throws an exception if the current page is a my page.

Parameters:

nGadgetID - - gadget id of the gadget whose setting is desired

strSetting - - name of the setting name that is desired

Returns:

Object[][] - array of name and corresponding value Object[0][0] = setting name Object[1][0] = setting value

LookupCommunityGadgetSettings

java.lang.Object[][] LookupCommunityGadgetSettings(int nGadgetID,
                                                   java.lang.Object arrSettings)

Deprecated.

Look up community-gadget settings (preferences) for the combination of the community that the current page is part of and the gadget id that is passed in. Throws an exception if the current page is a my page.

Parameters:

nGadgetID - - gadget id of the gadget whose settings are desired

arrSettings - - array of the setting names that are desired

Returns:

Object[][] - array of names and corresponding values Object[name(0) or value{1)][index] This function is being considered for removal.

AssignCommunityGadgetSettings

void AssignCommunityGadgetSettings(int nGadgetID,
                                   java.lang.Object[][] arrSettings)

Deprecated.

Assign a list of community-gadget settings (preferences) to the combination of the community that the current page is part of and a particular gadget. Calling this function will delete all the old settings for this community-gadget combination. Throws an exception if the current page is a my page.

Parameters:

nGadgetID - - gadget id of the gadget whose settings are desired

arrSettings - - array of the names and corresponding values to be assigned to the community-gadget combination.

AssignCommunityGadgetSettingsEx

void AssignCommunityGadgetSettingsEx(int nGadgetID,
                                     java.lang.Object[][] arrSettings,
                                     boolean bDeletePrefs)

Deprecated.

Assign a list of community-gadget settings (preferences) to the combination of the community that the current page is part of and a particular gadget. Throws an exception if the current page is a my page.

Parameters:

nGadgetID - - gadget id of the gadget whose settings are desired

arrSettings - - array of the names and corresponding values to be assigned to the community-gadget combination.

bDeletePrefs - - boolean that will delete the old settings for this community-gadget combination or append the new list to the old settings

RemoveCommunityGadgetSetting

void RemoveCommunityGadgetSetting(int nGadgetID,
                                  java.lang.String strCommunitySetting)

Deprecated.

Remove a community-gadget setting (preference) from the combination of the community that the current page is part of and a particular gadget. Throws an exception if the current page is a my page.

Parameters:

nGadgetID - - gadget id of the gadget whose setting is to be removed

strCommunitySetting - - name of the setting to be removed

AddSessionPreference

void AddSessionPreference(java.lang.String strSessionPreference,
                          java.lang.String strValue)

Deprecated.

Adds a session preference for the current user. This information is cached and not persisted to the database.

Parameters:

strSessionPreference - - The name of the preference to set.

strValue - - The value to associated with the above preference.

RemoveSessionPreference

void RemoveSessionPreference(java.lang.String strSessionPreference)

Deprecated.

Removes a session preference for the current user. This information is cached.

Parameters:

strSessionPreference - - The name of preference to be removed.

LookupSessionPreferences

java.lang.String[][] LookupSessionPreferences(java.lang.String[] astrPreferenceNames)

Deprecated.

This method looks up session preferences set for the current user.

Parameters:

astrSessionPreferenceNames - is an array of the names of preferences to look up.

Returns:

An array of Name-Value Pairs of the preferences.

LookupSessionPreference

java.lang.String[][] LookupSessionPreference(java.lang.String strSessionPreferenceName)

Deprecated.

This method looks up a preference set for the current user.

Parameters:

strSessionPreferenceName - is the name of the preference to look up.

Returns:

An array of Name-Value Pairs of the preferences.