com.plumtree.server
Interface IPTMyPortal

All Superinterfaces:
IPTUnknown

public interface IPTMyPortal
extends IPTUnknown

IPTMyPortal


Method Summary
 void AddCommunitySetting(java.lang.String strCommunitySetting, double dValue)
          Add a community setting (preference) to the community that the current page is part of.
 void AddCommunitySetting(java.lang.String strCommunitySetting, int nValue)
          Add a community setting (preference) to the community that the current page is part of.
 void AddCommunitySetting(java.lang.String strCommunitySetting, java.lang.Object objValue)
          Add a community setting (preference) to the community that the current page is part of.
 void AddCommunitySetting(java.lang.String strCommunitySetting, java.lang.String strValue)
          Add a community setting (preference) to the community that the current page is part of.
 void AddCommunitySetting(java.lang.String strCommunitySetting, com.plumtree.openfoundation.util.XPDateTime dtValue)
          Add a community setting (preference) to the community that the current page is part of.
 void AddGadget(int nGadgetID)
          Add one gadget to the page that this IPTMyPortal represents.
 void AddGadgetEx(int nGadgetID, int nColumnID)
          Add a gadget to a column on the page that this IPTMyPortal represents.
 void AddPersonalSetting(java.lang.String strPersonalSetting, double dValue)
          Add a personal setting (preference) for the current user.
 void AddPersonalSetting(java.lang.String strPersonalSetting, int nValue)
          Add a personal setting (preference) for the current user.
 void AddPersonalSetting(java.lang.String strPersonalSetting, java.lang.Object objValue)
          Add a personal setting (preference) for the current user.
 void AddPersonalSetting(java.lang.String strPersonalSetting, java.lang.String strValue)
          Add a personal setting (preference) for the current user.
 void AddPersonalSetting(java.lang.String strPersonalSetting, com.plumtree.openfoundation.util.XPDateTime dtValue)
          Add a personal setting (preference) for the current user.
 void AssignCommunityGadgetSettings(int nGadgetID, java.lang.Object[][] arrSettings)
          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.
 void AssignCommunityGadgetSettingsEx(int nGadgetID, java.lang.Object[][] arrSettings, boolean bDeletePrefs)
          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.
 void AssignGadgetSettings(int nGadgetID, java.lang.Object[][] arrSettings)
          Assign a list of user-gadget settings (preferences) to the combination of a particular gadget and the current user.
 void AssignGadgetSettingsEx(int nGadgetID, java.lang.Object[][] arrSettings, boolean bDeletePrefs)
          Assign a list of user-gadget settings (preferences) to the combination of a particular gadget and the current user.
 void AssignGadgetsEx(int[] arrGadgetIDs, int nColumnID)
          Assign a list of gadgets to a column on the page that this IPTMyPortal represents.
 void AssignGadgetsEx(int nGadgetID, int nColumnID)
          Assign a gadget to a column on the page that this IPTMyPortal represents.
 int GetCommunityID()
          Get the community id of the community that the current page is part of.
 java.lang.String GetCommunityName()
          Get the community name of the community that the current page is part of.
 int GetPageID()
          Get the Page ID of the page that this IPTMyPortal represents.
 java.lang.String GetPageName()
          Get the Page name of the page that this IPTMyPortal represents.
 int GetPageType()
          Get the type of the page that this IPTMyPortal represents.
 java.lang.String GetURL()
          Deprecated. - This function should not be called. The URL column in PTMyPages and PTCommPages should be removed as well.
 java.lang.Object[][] LookupCommunityGadgetSettings(int nGadgetID, java.lang.Object arrSettings)
          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.
 java.lang.Object[][] LookupCommunityGadgetSettings(int nGadgetID, java.lang.String strSetting)
          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.
 java.lang.Object[][] LookupCommunityGadgetSettings(int nGadgetID, java.lang.String[] arrSettings)
          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.
 java.lang.Object[][] LookupCommunitySettings(java.lang.Object arrSettings)
          Look up community settings (preferences) for the community that the current page is part of.
 java.lang.Object[][] LookupCommunitySettings(java.lang.String strSetting)
          Look up one community setting (preference) for the community that the current page is part of.
 java.lang.Object[][] LookupCommunitySettings(java.lang.String[] arrSettings)
          Look up community settings (preferences) for the community that the current page is part of.
 java.lang.Object[][] LookupGadgetSettings(int nGadgetID, java.lang.Object arrSettings)
          Look up a list of user-gadget settings (preferences) for the combination of a particular gadget and the current user.
 java.lang.Object[][] LookupGadgetSettings(int nGadgetID, java.lang.String strSetting)
          Look up one user-gadget setting (preference) for the combination of a particular gadget and the current user.
 java.lang.Object[][] LookupGadgetSettings(int nGadgetID, java.lang.String[] arrSettings)
          Look up a list of user-gadget settings (preferences) for the combination of a particular gadget and the current user.
 java.lang.Object[][] LookupPersonalSettings(java.lang.Object arrSettings)
          Look up a list of personal settings (preferences) for the current user.
 java.lang.Object[][] LookupPersonalSettings(java.lang.String strSetting)
          Look up one personal setting (preference) for the current user.
 java.lang.Object[][] LookupPersonalSettings(java.lang.String[] arrSettings)
          Look up a list of personal settings (preferences) for the current user.
 IPTMyPortalGadgetContent QueryGadgetContent(java.lang.Object objAppDataStateObject, java.lang.String strUserInterfaceID, int nMode, boolean bReturnAllGadgets)
          Query for the all of the gadget content on the page that this IPTMyPortal represents.
 IPTQueryResult QueryGadgets()
          Query for all the gadgets on the page that this IPTMyPortal represents.
 void RemoveCommunityGadgetSetting(int nGadgetID, java.lang.String strCommunitySetting)
          Remove a community-gadget setting (preference) from the combination of the community that the current page is part of and a particular gadget.
 void RemoveCommunitySetting(java.lang.String strCommunitySetting)
          Remove a community setting (preference) for the community that the current page is part of.
 void RemoveGadget(int nGadgetID)
          Remove one gadget from the page that this IPTMyPortal represents.
 void RemoveGadgetSetting(int nGadgetID, java.lang.String strSetting)
          Remove a user-gadget setting (preference) for the combination of a particular gadget and the current user.
 void RemovePersonalSetting(java.lang.String strPersonalSetting)
          Remove a personal setting (preference) for the current user.
 
Methods inherited from interface com.plumtree.server.IPTUnknown
GetInterfaces
 

Method Detail

QueryGadgets

public IPTQueryResult QueryGadgets()
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

public void AddGadget(int nGadgetID)
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

public void RemoveGadget(int nGadgetID)
Remove one gadget from the page that this IPTMyPortal represents.
Parameters:
nGadgetID - - gadget id of the gadget to remove

LookupGadgetSettings

public java.lang.Object[][] LookupGadgetSettings(int nGadgetID,
                                                 java.lang.String[] arrSettings)
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

public java.lang.Object[][] LookupGadgetSettings(int nGadgetID,
                                                 java.lang.String strSetting)
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

public java.lang.Object[][] LookupGadgetSettings(int nGadgetID,
                                                 java.lang.Object arrSettings)
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

public void AssignGadgetSettings(int nGadgetID,
                                 java.lang.Object[][] arrSettings)
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]

LookupPersonalSettings

public java.lang.Object[][] LookupPersonalSettings(java.lang.String[] arrSettings)
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

public java.lang.Object[][] LookupPersonalSettings(java.lang.String strSetting)
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

public java.lang.Object[][] LookupPersonalSettings(java.lang.Object arrSettings)
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

public void AddPersonalSetting(java.lang.String strPersonalSetting,
                               int nValue)
Add a personal setting (preference) for the current user.
Parameters:
strPersonalSetting - - name of the setting
nValue - - int value of the setting

AddPersonalSetting

public void AddPersonalSetting(java.lang.String strPersonalSetting,
                               java.lang.String strValue)
Add a personal setting (preference) for the current user.
Parameters:
strPersonalSetting - - name of the setting
strValue - - string value of the setting

AddPersonalSetting

public void AddPersonalSetting(java.lang.String strPersonalSetting,
                               com.plumtree.openfoundation.util.XPDateTime dtValue)
Add a personal setting (preference) for the current user.
Parameters:
strPersonalSetting - - name of the setting
dtValue - - XPDateTime value of the setting

AddPersonalSetting

public void AddPersonalSetting(java.lang.String strPersonalSetting,
                               double dValue)
Add a personal setting (preference) for the current user.
Parameters:
strPersonalSetting - - name of the setting
dValue - - double value of the setting

AddPersonalSetting

public void AddPersonalSetting(java.lang.String strPersonalSetting,
                               java.lang.Object objValue)
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

public void RemovePersonalSetting(java.lang.String strPersonalSetting)
Remove a personal setting (preference) for the current user.
Parameters:
strPersonalSetting - - name of the setting to be removed

QueryGadgetContent

public IPTMyPortalGadgetContent QueryGadgetContent(java.lang.Object objAppDataStateObject,
                                                   java.lang.String strUserInterfaceID,
                                                   int nMode,
                                                   boolean bReturnAllGadgets)
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

public int GetPageID()
Get the Page ID of the page that this IPTMyPortal represents.
Returns:
int - the page id

GetPageName

public java.lang.String GetPageName()
Get the Page name of the page that this IPTMyPortal represents.
Returns:
String - the page name

GetURL

public java.lang.String GetURL()
Deprecated. - This function should not be called. The URL column in PTMyPages and PTCommPages should be removed as well.

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

public int GetPageType()
Get the type of the page that this IPTMyPortal represents.
Returns:
int - the type, of which constants are defined in the UI

AssignGadgetsEx

public void AssignGadgetsEx(int[] arrGadgetIDs,
                            int nColumnID)
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

public void AssignGadgetsEx(int nGadgetID,
                            int nColumnID)
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

public void AddGadgetEx(int nGadgetID,
                        int nColumnID)
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

LookupCommunitySettings

public java.lang.Object[][] LookupCommunitySettings(java.lang.String[] arrSettings)
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

public java.lang.Object[][] LookupCommunitySettings(java.lang.String strSetting)
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

public java.lang.Object[][] LookupCommunitySettings(java.lang.Object arrSettings)
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

public void AddCommunitySetting(java.lang.String strCommunitySetting,
                                int nValue)
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

public void AddCommunitySetting(java.lang.String strCommunitySetting,
                                java.lang.String strValue)
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

public void AddCommunitySetting(java.lang.String strCommunitySetting,
                                com.plumtree.openfoundation.util.XPDateTime dtValue)
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

public void AddCommunitySetting(java.lang.String strCommunitySetting,
                                double dValue)
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

public void AddCommunitySetting(java.lang.String strCommunitySetting,
                                java.lang.Object objValue)
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

public void RemoveCommunitySetting(java.lang.String strCommunitySetting)
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

public java.lang.Object[][] LookupCommunityGadgetSettings(int nGadgetID,
                                                          java.lang.String[] arrSettings)
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

public java.lang.Object[][] LookupCommunityGadgetSettings(int nGadgetID,
                                                          java.lang.String strSetting)
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

public java.lang.Object[][] LookupCommunityGadgetSettings(int nGadgetID,
                                                          java.lang.Object arrSettings)
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

public void AssignCommunityGadgetSettings(int nGadgetID,
                                          java.lang.Object[][] arrSettings)
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

public void AssignCommunityGadgetSettingsEx(int nGadgetID,
                                            java.lang.Object[][] arrSettings,
                                            boolean bDeletePrefs)
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

public void RemoveCommunityGadgetSetting(int nGadgetID,
                                         java.lang.String strCommunitySetting)
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

AssignGadgetSettingsEx

public void AssignGadgetSettingsEx(int nGadgetID,
                                   java.lang.Object[][] arrSettings,
                                   boolean bDeletePrefs)
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

public void RemoveGadgetSetting(int nGadgetID,
                                java.lang.String strSetting)
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

GetCommunityID

public int GetCommunityID()
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

public java.lang.String GetCommunityName()
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


Copyright © 2003 Plumtree Software Inc. All Rights Reserved.