|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
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 |
public IPTQueryResult QueryGadgets()
public void AddGadget(int nGadgetID)
nGadgetID - - gadget id of the gadget to addpublic void RemoveGadget(int nGadgetID)
nGadgetID - - gadget id of the gadget to remove
public java.lang.Object[][] LookupGadgetSettings(int nGadgetID,
java.lang.String[] arrSettings)
nGadgetID - - gadget id of the gadget whose settings are desiredarrSettings - - array of setting names that are desired
public java.lang.Object[][] LookupGadgetSettings(int nGadgetID,
java.lang.String strSetting)
nGadgetID - - gadget id of the gadget whose settings are desiredstrSetting - - setting name that is desired
public java.lang.Object[][] LookupGadgetSettings(int nGadgetID,
java.lang.Object arrSettings)
nGadgetID - - gadget id of the gadget whose settings are desiredarrSettings - - array of setting names that are desired
public void AssignGadgetSettings(int nGadgetID,
java.lang.Object[][] arrSettings)
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]public java.lang.Object[][] LookupPersonalSettings(java.lang.String[] arrSettings)
arrSettings - - array of setting names that are desiredpublic java.lang.Object[][] LookupPersonalSettings(java.lang.String strSetting)
strSetting - - setting name that is desiredpublic java.lang.Object[][] LookupPersonalSettings(java.lang.Object arrSettings)
arrSettings - - array of setting names that are desired
public void AddPersonalSetting(java.lang.String strPersonalSetting,
int nValue)
strPersonalSetting - - name of the settingnValue - - int value of the setting
public void AddPersonalSetting(java.lang.String strPersonalSetting,
java.lang.String strValue)
strPersonalSetting - - name of the settingstrValue - - string value of the setting
public void AddPersonalSetting(java.lang.String strPersonalSetting,
com.plumtree.openfoundation.util.XPDateTime dtValue)
strPersonalSetting - - name of the settingdtValue - - XPDateTime value of the setting
public void AddPersonalSetting(java.lang.String strPersonalSetting,
double dValue)
strPersonalSetting - - name of the settingdValue - - double value of the setting
public void AddPersonalSetting(java.lang.String strPersonalSetting,
java.lang.Object objValue)
strPersonalSetting - - name of the settingobjValue - - object value of the setting
This function is being considered for removal.public void RemovePersonalSetting(java.lang.String strPersonalSetting)
strPersonalSetting - - name of the setting to be removed
public IPTMyPortalGadgetContent QueryGadgetContent(java.lang.Object objAppDataStateObject,
java.lang.String strUserInterfaceID,
int nMode,
boolean bReturnAllGadgets)
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 interfacepublic int GetPageID()
public java.lang.String GetPageName()
public java.lang.String GetURL()
public int GetPageType()
public void AssignGadgetsEx(int[] arrGadgetIDs,
int nColumnID)
arrGadgetIDs - - array of gadget ids that are to be addednColumnID - - column id in which to place all the gadgets
public void AssignGadgetsEx(int nGadgetID,
int nColumnID)
nGadgetID - - gadget id that is to be addednColumnID - - column id in which to place the gadget
public void AddGadgetEx(int nGadgetID,
int nColumnID)
nGadgetID - - gadget id that is to be addednColumnID - - column id in which to place the gadgetpublic java.lang.Object[][] LookupCommunitySettings(java.lang.String[] arrSettings)
arrSettings - - array of setting names that are desiredpublic java.lang.Object[][] LookupCommunitySettings(java.lang.String strSetting)
strSetting - - setting name that is desiredpublic java.lang.Object[][] LookupCommunitySettings(java.lang.Object arrSettings)
arrSettings - - array of setting names that are desired
public void AddCommunitySetting(java.lang.String strCommunitySetting,
int nValue)
strCommunitySetting - - name of the settingnValue - - int value of the setting
public void AddCommunitySetting(java.lang.String strCommunitySetting,
java.lang.String strValue)
strCommunitySetting - - name of the settingstrValue - - string value of the setting
public void AddCommunitySetting(java.lang.String strCommunitySetting,
com.plumtree.openfoundation.util.XPDateTime dtValue)
strCommunitySetting - - name of the settingdtValue - - XPDateTime value of the setting
public void AddCommunitySetting(java.lang.String strCommunitySetting,
double dValue)
strCommunitySetting - - name of the settingdValue - - double value of the setting
public void AddCommunitySetting(java.lang.String strCommunitySetting,
java.lang.Object objValue)
strCommunitySetting - - name of the settingobjValue - - object value of the setting
This function is being considered for removal.public void RemoveCommunitySetting(java.lang.String strCommunitySetting)
strCommunitySetting - - name of the setting to be removed
public java.lang.Object[][] LookupCommunityGadgetSettings(int nGadgetID,
java.lang.String[] arrSettings)
nGadgetID - - gadget id of the gadget whose settings are desiredarrSettings - - array of setting names that are desired
public java.lang.Object[][] LookupCommunityGadgetSettings(int nGadgetID,
java.lang.String strSetting)
nGadgetID - - gadget id of the gadget whose setting is desiredstrSetting - - name of the setting name that is desired
public java.lang.Object[][] LookupCommunityGadgetSettings(int nGadgetID,
java.lang.Object arrSettings)
nGadgetID - - gadget id of the gadget whose settings are desiredarrSettings - - array of the setting names that are desired
public void AssignCommunityGadgetSettings(int nGadgetID,
java.lang.Object[][] arrSettings)
nGadgetID - - gadget id of the gadget whose settings are desiredarrSettings - - array of the names and corresponding values to be assigned
to the community-gadget combination.
public void AssignCommunityGadgetSettingsEx(int nGadgetID,
java.lang.Object[][] arrSettings,
boolean bDeletePrefs)
nGadgetID - - gadget id of the gadget whose settings are desiredarrSettings - - 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
public void RemoveCommunityGadgetSetting(int nGadgetID,
java.lang.String strCommunitySetting)
nGadgetID - - gadget id of the gadget whose setting is to be removedstrCommunitySetting - - name of the setting to be removed
public void AssignGadgetSettingsEx(int nGadgetID,
java.lang.Object[][] arrSettings,
boolean bDeletePrefs)
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
public void RemoveGadgetSetting(int nGadgetID,
java.lang.String strSetting)
nGadgetID - - gadget id of the gadget whose setting is to be removedstrSetting - - name of the setting to be removedpublic int GetCommunityID()
public java.lang.String GetCommunityName()
|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||