com.plumtree.server
Interface IPTGadgetGateway

All Superinterfaces:
IPTUnknown

public interface IPTGadgetGateway
extends IPTUnknown

A global object available from the session via OpenGlobalObject that retrieves associated content via an HTTP gateway. -jas


Method Summary
 boolean CheckCommunityAccess(int nCommunityID, int nAccessLevelRequested)
          Checks if the current user has a specified level of access (e.g.
 boolean CheckGadgetAccess(int nGadgetID, int nAccessLevelRequested)
          Checks if the current user has a specified level of access (e.g.
 IPTContent GetContent(java.lang.Object vAppDataStateObject, int vContentID, int vObject, int nClassID, int nPageID, int nCommunityID, java.lang.String bstrUserInterface, int lMode, boolean bReturnAllGadgets)
          Passes through a URI request to the provider's IPTGadgetAssociatedContentProvider, if supported.
 IPTContent GetContent(java.lang.Object vAppDataStateObject, int vContentID, IPTGadget vObject, int nClassID, int nPageID, int nCommunityID, java.lang.String bstrUserInterface, int lMode, boolean bReturnAllGadgets)
          Passes through a URI request to the provider's IPTGadgetAssociatedContentProvider, if supported.
 IPTContent GetContent(java.lang.Object vAppDataStateObject, java.lang.String vContentID, int vObject, int nClassID, int nPageID, int nCommunityID, java.lang.String bstrUserInterface, int lMode, boolean bReturnAllGadgets)
          Passes through a URI request to the provider's IPTGadgetAssociatedContentProvider, if supported.
 IPTContent GetContent(java.lang.Object vAppDataStateObject, java.lang.String vContentID, IPTGadget vObject, int nClassID, int nPageID, int nCommunityID, java.lang.String bstrUserInterface, int lMode, boolean bReturnAllGadgets)
          Passes through a URI request to the provider's IPTGadgetAssociatedContentProvider, if supported.
 IPTMyPortalGadgetContent GetGadgetContent(java.lang.Object vAppDataStateObject, int[] vGadgetIDs, int nPageID, int nCommunityID, java.lang.String bstrUserInterface, int lMode, boolean bReturnAllGadgets)
          Deprecated.  
 IPTMyPortalGadgetContent GetGadgetContent(java.lang.Object vAppDataStateObject, int vGadgetIDs, int nPageID, int nCommunityID, java.lang.String bstrUserInterface, int lMode, boolean bReturnAllGadgets)
          Deprecated.  
 IPTGadgetInfo OpenGadgetInfo(int nGadgetID, int nPageID, int nCommunityID)
          Helper method for gadget pages.
 IPTGadgetInfo OpenGadgetInfoFromPage(int nGadgetID, IPTMyPortal pMyPortal)
          Helper method for pages that already have the IPTMyPortal object opened.
 
Methods inherited from interface com.plumtree.server.IPTUnknown
GetInterfaces
 

Method Detail

CheckGadgetAccess

public boolean CheckGadgetAccess(int nGadgetID,
                                 int nAccessLevelRequested)
Checks if the current user has a specified level of access (e.g. Read, Select, Edit, or Admin) to a portlet. -jas
Parameters:
nGadgetID - The portlet ID.
nAccessLevelRequested - Level of access requested, see PT_ACCESS_LEVELS.
Returns:
True if the current user has access.

CheckCommunityAccess

public boolean CheckCommunityAccess(int nCommunityID,
                                    int nAccessLevelRequested)
Checks if the current user has a specified level of access (e.g. Read, Select, Edit, or Admin) to a community. -jas
Parameters:
nCommunityID - The community ID.
nAccessLevelRequested - Level of access requested, see PT_ACCESS_LEVELS.
Returns:
True if the current user has access.

OpenGadgetInfo

public IPTGadgetInfo OpenGadgetInfo(int nGadgetID,
                                    int nPageID,
                                    int nCommunityID)
Helper method for gadget pages. -jas
Parameters:
nGadgetID - The portlet ID.
nPageID - The page ID, or 0 for the default page.
nCommunityID - The community ID, or 0 for the MyPage.
Returns:
Interface for reading and writing portlet preferences.

OpenGadgetInfoFromPage

public IPTGadgetInfo OpenGadgetInfoFromPage(int nGadgetID,
                                            IPTMyPortal pMyPortal)
Helper method for pages that already have the IPTMyPortal object opened. -jas
Parameters:
nGadgetID - The portlet ID.
pMyPortal - Opened from Session.MyPages.OpenPage or Community.OpenPage.
Returns:
Interface for reading and writing portlet preferences.

GetContent

public IPTContent GetContent(java.lang.Object vAppDataStateObject,
                             int vContentID,
                             IPTGadget vObject,
                             int nClassID,
                             int nPageID,
                             int nCommunityID,
                             java.lang.String bstrUserInterface,
                             int lMode,
                             boolean bReturnAllGadgets)
Passes through a URI request to the provider's IPTGadgetAssociatedContentProvider, if supported. -jas
Parameters:
vAppDataStateObject - Contains additonal arguments specific to the provider or the user interface.
vContentID - The content ID, see PT_ASSOCIATEDCONTENT.
vObject - The portlet object.
nClassID - The class ID of the object, see PT_CLASSIDS.
nPageID - The page ID, or 0 for the default page.
nCommunityID - The community ID, or 0 for the MyPage.
bstrUserInterface - URI of the user interface (e.g. devices, low bandwidth).
lMode - The mode, see see PT_GADGET_MODES.
bReturnAllGadgets - Return all portlets, or only those supporting bstrUserInterface.
Returns:
The content.

GetContent

public IPTContent GetContent(java.lang.Object vAppDataStateObject,
                             int vContentID,
                             int vObject,
                             int nClassID,
                             int nPageID,
                             int nCommunityID,
                             java.lang.String bstrUserInterface,
                             int lMode,
                             boolean bReturnAllGadgets)
Passes through a URI request to the provider's IPTGadgetAssociatedContentProvider, if supported. -jas
Parameters:
vAppDataStateObject - Contains additonal arguments specific to the provider or the user interface.
vContentID - The content ID, see PT_ASSOCIATEDCONTENT.
vObject - The object ID.
nClassID - The class ID of the object, see PT_CLASSIDS.
nPageID - The page ID, or 0 for the default page.
nCommunityID - The community ID, or 0 for the MyPage.
bstrUserInterface - URI of the user interface (e.g. devices, low bandwidth).
lMode - The mode, see see PT_GADGET_MODES.
bReturnAllGadgets - Return all portlets, or only those supporting bstrUserInterface.
Returns:
The content.

GetContent

public IPTContent GetContent(java.lang.Object vAppDataStateObject,
                             java.lang.String vContentID,
                             IPTGadget vObject,
                             int nClassID,
                             int nPageID,
                             int nCommunityID,
                             java.lang.String bstrUserInterface,
                             int lMode,
                             boolean bReturnAllGadgets)
Passes through a URI request to the provider's IPTGadgetAssociatedContentProvider, if supported. -jas
Parameters:
vAppDataStateObject - Contains additonal arguments specific to the provider or the user interface.
vContentID - The URI of the content.
vObject - The portlet object.
nClassID - The class ID of the object, see PT_CLASSIDS.
nPageID - The page ID, or 0 for the default page.
nCommunityID - The community ID, or 0 for the MyPage.
bstrUserInterface - URI of the user interface (e.g. devices, low bandwidth).
lMode - The mode, see see PT_GADGET_MODES.
bReturnAllGadgets - Return all portlets, or only those supporting bstrUserInterface.
Returns:
The content.

GetContent

public IPTContent GetContent(java.lang.Object vAppDataStateObject,
                             java.lang.String vContentID,
                             int vObject,
                             int nClassID,
                             int nPageID,
                             int nCommunityID,
                             java.lang.String bstrUserInterface,
                             int lMode,
                             boolean bReturnAllGadgets)
Passes through a URI request to the provider's IPTGadgetAssociatedContentProvider, if supported. -jas
Parameters:
vAppDataStateObject - Contains additonal arguments specific to the provider or the user interface.
vContentID - The URI of the content.
vObject - The object ID.
nClassID - The class ID of the object, see PT_CLASSIDS.
nPageID - The page ID, or 0 for the default page.
nCommunityID - The community ID, or 0 for the MyPage.
bstrUserInterface - URI of the user interface (e.g. devices, low bandwidth).
lMode - The mode, see see PT_GADGET_MODES.
bReturnAllGadgets - Return all portlets, or only those supporting bstrUserInterface.
Returns:
The content.

GetGadgetContent

public IPTMyPortalGadgetContent GetGadgetContent(java.lang.Object vAppDataStateObject,
                                                 int[] vGadgetIDs,
                                                 int nPageID,
                                                 int nCommunityID,
                                                 java.lang.String bstrUserInterface,
                                                 int lMode,
                                                 boolean bReturnAllGadgets)
Deprecated.  


GetGadgetContent

public IPTMyPortalGadgetContent GetGadgetContent(java.lang.Object vAppDataStateObject,
                                                 int vGadgetIDs,
                                                 int nPageID,
                                                 int nCommunityID,
                                                 java.lang.String bstrUserInterface,
                                                 int lMode,
                                                 boolean bReturnAllGadgets)
Deprecated.  



Copyright © 2003 Plumtree Software Inc. All Rights Reserved.