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

Author:
Joseph Stanko

Method Summary
 IPTContent GetContent(java.lang.Object vAppDataStateObject, int vContentID, int vObject, int nClassID, int nPageID, int nPageContainerClassID, int nPageContainerObjectID, 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, int vObject, int nClassID, int nPageID, int nCommunityID, java.lang.String bstrUserInterface, int lMode, boolean bReturnAllGadgets)
          Deprecated. Use GetContent (Object vAppDataStateObject, int vContentID, int vObject, int nClassID, int nPageID, int nPageContainerClassID, int nPageContainerObjectID, String bstrUserInterface, int lMode, boolean bReturnAllGadgets) instead.
 IPTContent GetContent(java.lang.Object vAppDataStateObject, int vContentID, IPTGadget vObject, int nClassID, int nPageID, int nPageContainerClassID, int nPageContainerObjectID, 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)
          Deprecated. Use GetContent (Object vAppDataStateObject, int vContentID, IPTGadget vObject, int nClassID, int nPageID, int nPageContainerClassID, int nPageContainerObjectID, String bstrUserInterface, int lMode, boolean bReturnAllGadgets) instead.
 IPTContent GetContent(java.lang.Object vAppDataStateObject, java.lang.String vContentID, int vObject, int nClassID, int nPageID, int nPageContainerClassID, int nPageContainerObjectID, 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)
          Deprecated. Use GetContent (Object vAppDataStateObject, String vContentID, int vObject, int nClassID, int nPageID, int nPageContainerClassID, int nPageContainerObjectID, String bstrUserInterface, int lMode, boolean bReturnAllGadgets) instead.
 IPTContent GetContent(java.lang.Object vAppDataStateObject, java.lang.String vContentID, IPTGadget vObject, int nClassID, int nPageID, int nPageContainerClassID, int nPageContainerObjectID, 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)
          Deprecated. Use GetContent (Object vAppDataStateObject, String vContentID, IPTGadget vObject, int nClassID, int nPageID, int nPageContainerClassID, int nPageContainerObjectID, String bstrUserInterface, int lMode, boolean bReturnAllGadgets) instead.
 IPTGadgetInfo OpenGadgetInfo(int nGadgetID, int nPageID, int nCommunityID)
          Deprecated. OpenGadgetInfo(int nGadgetID, int nPageID, int nCommunityID) is deprecated. Use OpenGadgetInfo(int nGadgetID, int nPageID, int nPageContainerClassID, int nPageContainerObjectID).
 IPTGadgetInfo OpenGadgetInfo(int nGadgetID, int nPageID, int nPageContainerClassID, int nPageContainerObjectID)
          Helper method for gadget pages.
 IPTGadgetInfo OpenGadgetInfoFromPage(int nGadgetID, IPTMyPortal pMyPortal)
          Deprecated. Method OpenGadgetInfoFromPage(int, IPTMyPortal) is deprecated. Use OpenGadgetInfo(int nGadgetID, int nPageID, int nPageContainerClassID, int nPageContainerObjectID).
 
Methods inherited from interface com.plumtree.server.IPTUnknown
GetInterfaces
 

Method Detail

OpenGadgetInfo

IPTGadgetInfo OpenGadgetInfo(int nGadgetID,
                             int nPageID,
                             int nPageContainerClassID,
                             int nPageContainerObjectID)
Helper method for gadget pages. -jas

Parameters:
nGadgetID - The portlet ID.
nPageID - The page ID, or 0 for the default page.
nPageContainerClassID - Class ID of the object that contains the page, if nPageContainerClassID = 0, then this is a My Page.
nPageContainerObjectID - Object ID of the object that contains the page
Returns:
Interface for reading and writing portlet preferences.

OpenGadgetInfo

IPTGadgetInfo OpenGadgetInfo(int nGadgetID,
                             int nPageID,
                             int nCommunityID)
Deprecated. OpenGadgetInfo(int nGadgetID, int nPageID, int nCommunityID) is deprecated. Use OpenGadgetInfo(int nGadgetID, int nPageID, int nPageContainerClassID, int nPageContainerObjectID).

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

IPTGadgetInfo OpenGadgetInfoFromPage(int nGadgetID,
                                     IPTMyPortal pMyPortal)
Deprecated. Method OpenGadgetInfoFromPage(int, IPTMyPortal) is deprecated. Use OpenGadgetInfo(int nGadgetID, int nPageID, int nPageContainerClassID, int nPageContainerObjectID).

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

IPTContent GetContent(java.lang.Object vAppDataStateObject,
                      int vContentID,
                      IPTGadget vObject,
                      int nClassID,
                      int nPageID,
                      int nCommunityID,
                      java.lang.String bstrUserInterface,
                      int lMode,
                      boolean bReturnAllGadgets)
Deprecated. Use GetContent (Object vAppDataStateObject, int vContentID, IPTGadget vObject, int nClassID, int nPageID, int nPageContainerClassID, int nPageContainerObjectID, String bstrUserInterface, int lMode, boolean bReturnAllGadgets) instead.

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

IPTContent GetContent(java.lang.Object vAppDataStateObject,
                      int vContentID,
                      int vObject,
                      int nClassID,
                      int nPageID,
                      int nCommunityID,
                      java.lang.String bstrUserInterface,
                      int lMode,
                      boolean bReturnAllGadgets)
Deprecated. Use GetContent (Object vAppDataStateObject, int vContentID, int vObject, int nClassID, int nPageID, int nPageContainerClassID, int nPageContainerObjectID, String bstrUserInterface, int lMode, boolean bReturnAllGadgets) instead.

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

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)
Deprecated. Use GetContent (Object vAppDataStateObject, String vContentID, IPTGadget vObject, int nClassID, int nPageID, int nPageContainerClassID, int nPageContainerObjectID, String bstrUserInterface, int lMode, boolean bReturnAllGadgets) instead.

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

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)
Deprecated. Use GetContent (Object vAppDataStateObject, String vContentID, int vObject, int nClassID, int nPageID, int nPageContainerClassID, int nPageContainerObjectID, String bstrUserInterface, int lMode, boolean bReturnAllGadgets) instead.

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.

GetContent

IPTContent GetContent(java.lang.Object vAppDataStateObject,
                      int vContentID,
                      IPTGadget vObject,
                      int nClassID,
                      int nPageID,
                      int nPageContainerClassID,
                      int nPageContainerObjectID,
                      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.
nPageContainerClassID - The page container's class ID, 0 for a My Page
nPageContainerObjectID - The page container's object ID
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

IPTContent GetContent(java.lang.Object vAppDataStateObject,
                      int vContentID,
                      int vObject,
                      int nClassID,
                      int nPageID,
                      int nPageContainerClassID,
                      int nPageContainerObjectID,
                      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.
nPageContainerClassID - The page container's class ID, 0 for a My Page
nPageContainerObjectID - The page container's object ID
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

IPTContent GetContent(java.lang.Object vAppDataStateObject,
                      java.lang.String vContentID,
                      IPTGadget vObject,
                      int nClassID,
                      int nPageID,
                      int nPageContainerClassID,
                      int nPageContainerObjectID,
                      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.
nPageContainerClassID - The page container's class ID, 0 for a My Page
nPageContainerObjectID - The page container's object ID
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

IPTContent GetContent(java.lang.Object vAppDataStateObject,
                      java.lang.String vContentID,
                      int vObject,
                      int nClassID,
                      int nPageID,
                      int nPageContainerClassID,
                      int nPageContainerObjectID,
                      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.
nPageContainerClassID - The page container's class ID, 0 for a My Page
nPageContainerObjectID - The page container's object ID
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.


Copyright 2008 Plumtree Software Inc. All Rights Reserved.