WebCenter Interaction API  
 

IPTGadgetInfo Members

IPTGadgetInfo overview

Public Instance Methods

public methodAddCommunitySettingOverloaded. 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.
public methodAddPersonalSettingOverloaded. Add a personal setting (preference) for the current user.
public methodAddSessionPreference Adds a session preference for the current user. This information is cached and not persisted to the database.
public methodAssignCommunityGadgetSettings 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.
public methodAssignCommunityGadgetSettingsEx 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.
public methodAssignGadgetSettings 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.
public methodAssignGadgetSettingsEx Assign a list of user-gadget settings (preferences) to the combination of the gadget represented and the current user.
public methodGetAlignment Returns the portlet alignment. If the object is not a portlet, it returns PT_GADGETALIGN_NONE (zero).
public methodGetClassID Get the class id for the gadget represented
public methodGetCommunityID Get the community id of the community that the current gadget is from. Returns 0 if the current page is a my page.
public methodGetLocalizedPortletName Returns the string which is the localized portlet name. If the object is not a portlet, it returns null.
public methodGetObjectID Get the object id of the gadget represented
public methodGetPageContainerClassID 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.
public methodGetPageContainerObjectID 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.
public methodGetPageID Get the Page ID of the page that this IPTGadgetInfo is from.
public methodLookupAdminGadgetSettingsOverloaded. Look up admin-gadget settings (preferences) for the combination of the community that the current page is part of and the gadget represented.
public methodLookupCommunityGadgetSettingsOverloaded. 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.
public methodLookupCommunitySettingsOverloaded. 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.
public methodLookupGadgetSettingsOverloaded. Look up a list of user-gadget settings (preferences) for the combination of the gadget represented and the current user.
public methodLookupPersonalSettingsOverloaded. Look up a list of personal settings (preferences) for the current user.
public methodLookupSessionPreference This method looks up a preference set for the current user.
public methodLookupSessionPreferences This method looks up session preferences set for the current user.
public methodRemoveCommunityGadgetSetting 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.
public methodRemoveCommunitySetting 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.
public methodRemoveGadgetSetting Remove a user-gadget setting (preference) for the combination of a the gadget represented and the current user.
public methodRemovePersonalSetting Remove a personal setting (preference) for the current user.
public methodRemoveSessionPreference Removes a session preference for the current user. This information is cached.

See Also

IPTGadgetInfo Interface | com.plumtree.server Namespace