com.plumtree.server
Interface IPTGadgetBundle
- All Superinterfaces:
- IPTLocalizable, IPTObject, IPTServerContext, IPTStorable, IPTUnknown
public interface IPTGadgetBundle
- extends IPTObject
- Author:
- Robert Zhang
Method Summary |
void |
AddGadgetEx(int nGadgetID)
Adds a gadget to the Gadget bundle. |
void |
AssignGadgetsEx(int[] arGadgetIDs)
Assigns a new list of gadgets to the Gadget bundle. |
IPTQueryResult |
QueryGadgets(java.lang.Object[] arGadgetTypes)
Queries for gadgets in this Gadget bundle the user has at least READ access to. |
void |
RemoveGadget(int nGadgetID)
Removes a gadget from the Gadget bundle. |
Methods inherited from interface com.plumtree.server.IPTLocalizable |
GetDescription, GetIsLocalized, GetLocalizedDescription, GetLocalizedDescriptions, GetLocalizedName, GetLocalizedNames, GetName, GetPrimaryLang, GetSupportsLocalization, SetDescription, SetIsLocalized, SetLocalizedDescriptions, SetLocalizedNames, SetName, SetPrimaryLang |
Methods inherited from interface com.plumtree.server.IPTServerContext |
GetAccessLevel, GetACL, GetLastModifiedBy, GetLockState, GetObjectID, GetOwnerID, GetServerContextSettings, GetSession, GetSettings, LockObject, SetLastModifiedBy, SetObjectID, SetOwnerID, SetServerContextSettings, SetSettings, UnlockObject |
AssignGadgetsEx
void AssignGadgetsEx(int[] arGadgetIDs)
- Assigns a new list of gadgets to the Gadget bundle.
- Parameters:
arGadgetIDs
- Array of gadget IDs, all IDs need to be unique, and
at least EDIT access to the GadgetBundle and at least
SELECT access to the gadgets, is required.
AddGadgetEx
void AddGadgetEx(int nGadgetID)
- Adds a gadget to the Gadget bundle.
- Parameters:
nGadgetID
- ID of a gadget, at least EDIT access to the GadgetBundle and
at least SELECT access to the gadget is required.
RemoveGadget
void RemoveGadget(int nGadgetID)
- Removes a gadget from the Gadget bundle.
- Parameters:
nGadgetID
- ID of a gadget, at least EDIT access to the GadgetBundle is required.
QueryGadgets
IPTQueryResult QueryGadgets(java.lang.Object[] arGadgetTypes)
- Queries for gadgets in this Gadget bundle the user has at least READ access to.
- Parameters:
arGadgetTypes
- Integer array of optional queryfilters on the GadgetType column, types defined in
PT_GADGET_TYPES. Multiple entries are ORed.
Pass in an empty array to return all types of gadgets.
- Returns:
- IPTQueryResult QueryResult with gadgets from this Gadget bundle with the following columns:
PT_PROPIDS.PT_PROPID_OBJECTID;
PT_PROPIDS.PT_PROPID_NAME;
PT_PROPIDS.PT_PROPID_DESCRIPTION;
PT_PROPIDS.PT_PROPID_ISLOCALIZED;
PT_PROPIDS.PT_PROPID_FOLDERID;
PT_PROPIDS.PT_PROPID_GADGET_ALIGNMENT;
PT_PROPIDS.PT_PROPID_GADGET_GADGETTYPE;
PT_PROPIDS.PT_PROPID_ACCESSLEVEL;
- See Also:
PT_GADGET_TYPES
,
PT_PROPIDS
Copyright © 2008 Plumtree Software Inc. All Rights Reserved.