|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface IPTGadgetInfo
IPTGadgetInfo
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 |
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 |
AddSessionPreference(java.lang.String strSessionPreference,
java.lang.String strValue)
Adds a session preference for the current user. |
void |
AssignCommunityGadgetSettings(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 the gadget represented. |
void |
AssignCommunityGadgetSettingsEx(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 gadget represented. |
void |
AssignGadgetSettings(java.lang.Object[][] arrSettings)
Assign a list of user-gadget settings (preferences) to the combination the gadget represented and the current user. |
void |
AssignGadgetSettingsEx(java.lang.Object[][] arrSettings,
boolean bDeletePrefs)
Assign a list of user-gadget settings (preferences) to the combination of the gadget represented and the current user. |
int |
GetAlignment()
Returns the portlet alignment. |
int |
GetClassID()
Get the class id for the gadget represented |
int |
GetCommunityID()
Deprecated. use GetPageContainerClassID and GetPageContainerObjectID instead |
java.lang.String |
GetLocalizedPortletName()
Returns the string which is the localized portlet name. |
int |
GetObjectID()
Get the object id of the gadget represented |
int |
GetPageContainerClassID()
Get the page container class id of the page container of the page that the current gadget is from. |
int |
GetPageContainerObjectID()
Get the page container object id of the page container of the page that the current gadget is from. |
int |
GetPageID()
Get the Page ID of the page that this IPTGadgetInfo is from. |
java.lang.Object[][] |
LookupAdminGadgetSettings(java.lang.Object arrSettings)
Look up admin-gadget settings (preferences) for the combination of the community that the current page is part of and the gadget represented. |
java.lang.Object[][] |
LookupAdminGadgetSettings(java.lang.String strSetting)
Look up an admin-gadget setting (preference) for the combination of the community that the current page is part of and the gadget represented. |
java.lang.Object[][] |
LookupAdminGadgetSettings(java.lang.String[] arrSettings)
Look up admin-gadget settings (preferences) for the combination of the community that the current page is part of and the gadget represented. |
java.lang.Object[][] |
LookupCommunityGadgetSettings(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 represented. |
java.lang.Object[][] |
LookupCommunityGadgetSettings(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 represented. |
java.lang.Object[][] |
LookupCommunityGadgetSettings(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 represented. |
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 belongs to. |
java.lang.Object[][] |
LookupGadgetSettings(java.lang.Object arrSettings)
Look up a list of user-gadget settings (preferences) for the combination the gadget represented and the current user. |
java.lang.Object[][] |
LookupGadgetSettings(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(java.lang.String[] arrSettings)
Look up a list of user-gadget settings (preferences) for the combination of the gadget represented 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. |
java.lang.String[][] |
LookupSessionPreference(java.lang.String strSessionPreferenceName)
This method looks up a preference set for the current user. |
java.lang.String[][] |
LookupSessionPreferences(java.lang.String[] astrPreferenceNames)
This method looks up session preferences set for the current user. |
void |
RemoveCommunityGadgetSetting(java.lang.String strCommunitySetting)
Remove a community-gadget setting (preference) from the combination of the community that the current page is part of and the gadget represented. |
void |
RemoveCommunitySetting(java.lang.String strCommunitySetting)
Remove a community setting (preference) for the community that the current page is part of. |
void |
RemoveGadgetSetting(java.lang.String strSetting)
Remove a user-gadget setting (preference) for the combination of a the gadget represented and the current user. |
void |
RemovePersonalSetting(java.lang.String strPersonalSetting)
Remove a personal setting (preference) for the current user. |
void |
RemoveSessionPreference(java.lang.String strSessionPreference)
Removes a session preference for the current user. |
Method Detail |
---|
java.lang.Object[][] LookupGadgetSettings(java.lang.String[] arrSettings)
arrSettings
- - array of setting names that are desired
java.lang.Object[][] LookupGadgetSettings(java.lang.String strSetting)
strSetting
- - setting name that is desired
java.lang.Object[][] LookupGadgetSettings(java.lang.Object arrSettings)
arrSettings
- - array of setting names that are desired
void AssignGadgetSettings(java.lang.Object[][] arrSettings)
arrSettings
- - array of names and corresponding values to be set
on the gadget.
Object[name(0) or value(1)][index]java.lang.Object[][] LookupPersonalSettings(java.lang.String[] arrSettings)
arrSettings
- - array of setting names that are desired
java.lang.Object[][] LookupPersonalSettings(java.lang.String strSetting)
strSetting
- - setting name that is desired
java.lang.Object[][] LookupPersonalSettings(java.lang.Object arrSettings)
arrSettings
- - array of setting names that are desired
void AddPersonalSetting(java.lang.String strPersonalSetting, int nValue)
strPersonalSetting
- - name of the settingnValue
- - int value of the settingvoid AddPersonalSetting(java.lang.String strPersonalSetting, java.lang.String strValue)
strPersonalSetting
- - name of the settingstrValue
- - string value of the settingvoid AddPersonalSetting(java.lang.String strPersonalSetting, com.plumtree.openfoundation.util.XPDateTime dtValue)
strPersonalSetting
- - name of the settingdtValue
- - XPDateTime value of the settingvoid AddPersonalSetting(java.lang.String strPersonalSetting, double dValue)
strPersonalSetting
- - name of the settingdValue
- - double value of the settingvoid 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.void RemovePersonalSetting(java.lang.String strPersonalSetting)
strPersonalSetting
- - name of the setting to be removedjava.lang.Object[][] LookupCommunitySettings(java.lang.String[] arrSettings)
arrSettings
- - array of setting names that are desired
java.lang.Object[][] LookupCommunitySettings(java.lang.String strSetting)
strSetting
- - setting name that is desired
java.lang.Object[][] LookupCommunitySettings(java.lang.Object arrSettings)
arrSettings
- - array of setting names that are desired
void AddCommunitySetting(java.lang.String strCommunitySetting, int nValue)
strCommunitySetting
- - name of the settingnValue
- - string value of the settingvoid AddCommunitySetting(java.lang.String strCommunitySetting, java.lang.String strValue)
strCommunitySetting
- - name of the settingstrValue
- - string value of the settingvoid AddCommunitySetting(java.lang.String strCommunitySetting, com.plumtree.openfoundation.util.XPDateTime dtValue)
strCommunitySetting
- - name of the settingdtValue
- - XPDateTime value of the settingvoid AddCommunitySetting(java.lang.String strCommunitySetting, double dValue)
strCommunitySetting
- - name of the settingdValue
- - double value of the settingvoid 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.void RemoveCommunitySetting(java.lang.String strCommunitySetting)
strCommunitySetting
- - name of the setting to be removedjava.lang.Object[][] LookupCommunityGadgetSettings(java.lang.String[] arrSettings)
arrSettings
- - array of setting names that are desired
java.lang.Object[][] LookupCommunityGadgetSettings(java.lang.String strSetting)
strSetting
- - name of the setting name that is desired
java.lang.Object[][] LookupCommunityGadgetSettings(java.lang.Object arrSettings)
arrSettings
- - array of the setting names that are desired
void AssignCommunityGadgetSettings(java.lang.Object[][] arrSettings)
arrSettings
- - array of the names and corresponding values to be assigned
to the community-gadget combination.java.lang.Object[][] LookupAdminGadgetSettings(java.lang.String[] arrSettings)
arrSettings
- - array of the names and corresponding values to be assigned
to the community-gadget combination.
java.lang.Object[][] LookupAdminGadgetSettings(java.lang.String strSetting)
strSetting
- - name of the setting name that is desired
java.lang.Object[][] LookupAdminGadgetSettings(java.lang.Object arrSettings)
arrSettings
- - array of the names and corresponding values to be assigned
to the community-gadget combination.
void AssignCommunityGadgetSettingsEx(java.lang.Object[][] arrSettings, boolean bDeletePrefs)
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 settingsvoid RemoveCommunityGadgetSetting(java.lang.String strCommunitySetting)
strCommunitySetting
- - name of the setting to be removedvoid AssignGadgetSettingsEx(java.lang.Object[][] arrSettings, boolean bDeletePrefs)
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 settingsvoid RemoveGadgetSetting(java.lang.String strSetting)
strSetting
- - name of the setting to be removedint GetObjectID()
int GetClassID()
int GetPageID()
int GetCommunityID()
int GetPageContainerClassID()
int GetPageContainerObjectID()
void AddSessionPreference(java.lang.String strSessionPreference, java.lang.String strValue)
strSessionPreference
- - The name of the preference to set.strValue
- - The value to associated with the above preference.void RemoveSessionPreference(java.lang.String strSessionPreference)
strSessionPreference
- - The name of preference to be removed.java.lang.String[][] LookupSessionPreferences(java.lang.String[] astrPreferenceNames)
astrSessionPreferenceNames
- is an array of the names of preferences to look up.
java.lang.String[][] LookupSessionPreference(java.lang.String strSessionPreferenceName)
strSessionPreferenceName
- is the name of the preference to look up.
java.lang.String GetLocalizedPortletName()
int GetAlignment()
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |