com.plumtree.server
Interface IPTGadgetAssociatedContentProvider

public interface IPTGadgetAssociatedContentProvider

The interface implemented by provider that wish to expose associated content files to the portal. Each piece of content will have an identifier (an URL for HTTP gadgets, for example). There are some predefined constants for getting particular content that only the provider knows about such as a preferences page, see PT_ASSOCIATEDCONTENT. -jas

Author:

Joseph Stanko

Method Summary

IPTContent	GetContent(int lMode, int vContentID, java.lang.Object vAppDataStateObject, IPTSession pUserSession, IPTGadgetInfo pGadgetInfo, IPTAdminSettings pAdminSettings, IPTUserInterface pUserInterface) Get a piece of associated content when given the mode and the content identifier.
IPTContent	GetContent(int lMode, java.lang.String vContentID, java.lang.Object vAppDataStateObject, IPTSession pUserSession, IPTGadgetInfo pGadgetInfo, IPTAdminSettings pAdminSettings, IPTUserInterface pUserInterface) Get a piece of associated content when given the mode and the content identifier.

Method Detail

GetContent

IPTContent GetContent(int lMode,
                      java.lang.String vContentID,
                      java.lang.Object vAppDataStateObject,
                      IPTSession pUserSession,
                      IPTGadgetInfo pGadgetInfo,
                      IPTAdminSettings pAdminSettings,
                      IPTUserInterface pUserInterface)

Get a piece of associated content when given the mode and the content identifier. -jas

Parameters:

lMode - The mode, see see PT_GADGET_MODES.

vContentID - The URI of the content.

vAppDataStateObject - Contains additonal arguments specific to the provider or the user interface.

pUserSession - The current user's session.

pGadgetInfo - Used to get and set persistent settings.

pAdminSettings - Used to set administrator settings. Null if the current user cannot set admin settings in the current mode or context.

pUserInterface - The user interface (e.g. devices, low bandwidth). Optional, may be null.

Returns:

The content.

GetContent

IPTContent GetContent(int lMode,
                      int vContentID,
                      java.lang.Object vAppDataStateObject,
                      IPTSession pUserSession,
                      IPTGadgetInfo pGadgetInfo,
                      IPTAdminSettings pAdminSettings,
                      IPTUserInterface pUserInterface)

Get a piece of associated content when given the mode and the content identifier. -jas

Parameters:

lMode - The mode, see see PT_GADGET_MODES.

vContentID - The content ID, see PT_ASSOCIATEDCONTENT.

vAppDataStateObject - Contains additonal arguments specific to the provider or the user interface.

pUserSession - The current user's session.

pGadgetInfo - Used to get and set persistent settings.

pAdminSettings - Used to set administrator settings. Null if the current user cannot set admin settings in the current mode or context.

pUserInterface - The user interface (e.g. devices, low bandwidth). Optional, may be null.

Returns:

The content.