Aqualogic Interaction API  
 

IPTGadgetInfo Members

IPTGadgetInfo overview

Public Instance Methods

AddCommunitySettingOverloaded. 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.
AddPersonalSettingOverloaded. Add a personal setting (preference) for the current user.
AddSessionPreference Adds a session preference for the current user. This information is cached and not persisted to the database.
AssignCommunityGadgetSettings Assign a list of community-gadget settings (preferences) to the combination of the community that the current page is part of the gadget represented. 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.
AssignCommunityGadgetSettingsEx Assign a list of community-gadget settings (preferences) to the combination of the community that the current page is part of and gadget represented. Throws an exception if the current page is a my page.
AssignGadgetSettings Assign a list of user-gadget settings (preferences) to the combination the gadget represented and the current user. Calling this function will delete all the old settings for this gadget and user.
AssignGadgetSettingsEx Assign a list of user-gadget settings (preferences) to the combination of the gadget represented and the current user.
GetAlignment Returns the portlet alignment. If the object is not a portlet, it returns PT_GADGETALIGN_NONE (zero).
GetClassID Get the class id for the gadget represented
GetCommunityID Get the community id of the community that the current gadget is from. Returns 0 if the current page is a my page.
GetLocalizedPortletName Returns the string which is the localized portlet name. If the object is not a portlet, it returns null.
GetObjectID Get the object id of the gadget represented
GetPageContainerClassID Get the page container class id of the page container of the page that the current gadget is from. Returns 0 if the current page is a my page.
GetPageContainerObjectID Get the page container object id of the page container of the page that the current gadget is from. Returns 0 if the current page is a my page.
GetPageID Get the Page ID of the page that this IPTGadgetInfo is from.
LookupAdminGadgetSettingsOverloaded. Look up admin-gadget settings (preferences) for the combination of the community that the current page is part of and the gadget represented.
LookupCommunityGadgetSettingsOverloaded. Look up community-gadget settings (preferences) for the combination of the community that the current page is part of and the gadget represented. Throws an exception if the current page is a my page.
LookupCommunitySettingsOverloaded. Look up community settings (preferences) for the community that the current page belongs to. Throws an exception if the current page is a my page.
LookupGadgetSettingsOverloaded. Look up a list of user-gadget settings (preferences) for the combination of the gadget represented and the current user.
LookupPersonalSettingsOverloaded. Look up a list of personal settings (preferences) for the current user.
LookupSessionPreference This method looks up a preference set for the current user.
LookupSessionPreferences This method looks up session preferences set for the current user.
RemoveCommunityGadgetSetting Remove a community-gadget setting (preference) from the combination of the community that the current page is part of and the gadget represented. Throws an exception if the current page is a my page.
RemoveCommunitySetting 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.
RemoveGadgetSetting Remove a user-gadget setting (preference) for the combination of a the gadget represented and the current user.
RemovePersonalSetting Remove a personal setting (preference) for the current user.
RemoveSessionPreference Removes a session preference for the current user. This information is cached.

See Also

IPTGadgetInfo Interface | com.plumtree.server Namespace