|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface IPTAsyncGadgetProvider
The interface implemented by portlet providers that support asynchronous processing. Providers are initialized once and then cached. To render a community or a mypage, the server calls BeginProcessing once for each provider, then calls GetHTMLText once for each provider, passing the same arguments that were passed to BeginProcessing. -jas
Method Summary | |
---|---|
int |
BeginProcessing(int lMode,
IPTSession pUserSession,
IPTGadgetInfo pGadgetInfo,
IPTStates pStates,
IPTAdminSettings pAdminSettings,
java.lang.Object vAppDataStateObject,
IPTUserInterface pUserInterface)
Same as BeginProcessing (int lMode, IPTSession pUserSession, IPTGadgetInfo pGadgetInfo, IPTStates pStates, IPTAdminSettings pAdminSettings, Object vAppDataStateObject, IPTUserInterface pUserInterface, int nStateMode), but nStateMode is set to PT_STATEMODES.PT_STATEMODES_REQUEST |
int |
BeginProcessing(int lMode,
IPTSession pUserSession,
IPTGadgetInfo pGadgetInfo,
IPTStates pStates,
IPTAdminSettings pAdminSettings,
java.lang.Object vAppDataStateObject,
IPTUserInterface pUserInterface,
int nStateMode)
The Provider must be Initialized before this method may be called. |
int |
GetCapabilitiesAsInt(int lGadgetCapability)
Query a particular capability of this provider. |
java.lang.Object |
GetCapabilitiesAsObject(int lGadgetCapability)
Deprecated. |
java.lang.Object[][] |
GetCollapsedOrErrorContent(java.lang.Object spAppGatewayInfo,
IPTGadgetInfo spGadgetInfo,
boolean bCollapsed)
Get the content of this portlet that should be displayed in case the portlet is collapsed or has an error. |
java.lang.String |
GetDescription()
A short description of this provider. |
java.lang.String |
GetGadgetBrowserCLSID()
Deprecated. |
java.lang.String |
GetGadgetProviderCLSID()
The CLSID for this provider. |
java.lang.Object[][] |
GetHTMLText(int lMode,
IPTSession pUserSession,
IPTGadgetInfo pGadgetInfo,
IPTStates pStates,
IPTAdminSettings pAdminSettings,
java.lang.Object vAppDataStateObject,
IPTUserInterface pUserInterface)
Same as GetHTMLText (int lMode, IPTSession pUserSession, IPTGadgetInfo pGadgetInfo, IPTStates pStates, IPTAdminSettings pAdminSettings, Object vAppDataStateObject, IPTUserInterface pUserInterface, int nStateMode), but nStateMode is set to PT_STATEMODES.PT_STATEMODES_REQUEST |
java.lang.Object[][] |
GetHTMLText(int lMode,
IPTSession pUserSession,
IPTGadgetInfo pGadgetInfo,
IPTStates pStates,
IPTAdminSettings pAdminSettings,
java.lang.Object vAppDataStateObject,
IPTUserInterface pUserInterface,
int nStateMode)
Get the HTML text for this portlet as an array of markup fragments, some of which require post-processing. |
java.lang.String |
GetImageUUID()
Get the Image UUID for this Provider (used to find the correct Icon or GIF for the Gadget). |
java.lang.String |
GetName()
The name of this provider (human readable unique identifier). |
void |
Initialize(IPTGadgetCacheSite pCacheSite,
com.plumtree.openfoundation.util.IXPPropertyBag pbagConfigurationInfo,
com.plumtree.openfoundation.util.IXPPropertyBag pbagWebServiceConfigurationInfo,
IPTGadgetContentServer pGCServer)
Initializes all of the data structures in this object and must be called before BeginProcessing. |
java.lang.String |
SpecificGadgetDescription(com.plumtree.openfoundation.util.IXPPropertyBag pbagConfigurationInfo)
Retrieve a specific description of the current configuration info. |
Method Detail |
---|
void Initialize(IPTGadgetCacheSite pCacheSite, com.plumtree.openfoundation.util.IXPPropertyBag pbagConfigurationInfo, com.plumtree.openfoundation.util.IXPPropertyBag pbagWebServiceConfigurationInfo, IPTGadgetContentServer pGCServer)
pCacheSite
- The Cache Site entry for the portletpbagConfigurationInfo
- Configuration information about the current portletpbagWebServiceConfigurationInfo
- Configuration information about the portlet web service used by the current portletpGCServer
- The remote server used by the portlet web serviceint BeginProcessing(int lMode, IPTSession pUserSession, IPTGadgetInfo pGadgetInfo, IPTStates pStates, IPTAdminSettings pAdminSettings, java.lang.Object vAppDataStateObject, IPTUserInterface pUserInterface, int nStateMode)
lMode
- The mode, see see PT_GADGET_MODES
.pUserSession
- The current user's session.pGadgetInfo
- Used to get and set persistent settings.pStates
- State information, used to store page, session, and application level state.pAdminSettings
- Used to set administrator settings. Null if the current user cannot set admin settings in the current mode or context.vAppDataStateObject
- Contains additonal arguments specific to the provider or the user interface.pUserInterface
- The user interface (e.g. devices, low bandwidth). Optional, may be null.nStateMode
- The state to use for storing the requests PT_STATEMODES
.
int BeginProcessing(int lMode, IPTSession pUserSession, IPTGadgetInfo pGadgetInfo, IPTStates pStates, IPTAdminSettings pAdminSettings, java.lang.Object vAppDataStateObject, IPTUserInterface pUserInterface)
lMode
- pUserSession
- pGadgetInfo
- pStates
- pAdminSettings
- vAppDataStateObject
- pUserInterface
-
java.lang.Object[][] GetHTMLText(int lMode, IPTSession pUserSession, IPTGadgetInfo pGadgetInfo, IPTStates pStates, IPTAdminSettings pAdminSettings, java.lang.Object vAppDataStateObject, IPTUserInterface pUserInterface, int nStateMode)
lMode
- The mode, see see PT_GADGET_MODES
.pUserSession
- The current user's session.pGadgetInfo
- Used to get and set persistent settings.pStates
- State information, used to store page, session, and application level state.pAdminSettings
- Used to set administrator settings. Null if the current user cannot set admin settings in the current mode or context.vAppDataStateObject
- Contains additonal arguments specific to the provider or the user interface.pUserInterface
- The user interface (e.g. devices, low bandwidth). Optional, may be null.nStateMode
- The state to use for storing the requests PT_STATEMODES
.
PT_MARKUP_ARRAY_COLS
.java.lang.Object[][] GetHTMLText(int lMode, IPTSession pUserSession, IPTGadgetInfo pGadgetInfo, IPTStates pStates, IPTAdminSettings pAdminSettings, java.lang.Object vAppDataStateObject, IPTUserInterface pUserInterface)
lMode
- pUserSession
- pGadgetInfo
- pStates
- pAdminSettings
- vAppDataStateObject
- pUserInterface
-
java.lang.Object[][] GetCollapsedOrErrorContent(java.lang.Object spAppGatewayInfo, IPTGadgetInfo spGadgetInfo, boolean bCollapsed)
spAppGatewayInfo
- app data objectspGadgetInfo
- Used to get and set persistent settingsboolean
- bCollapsed True if the portlet is collapsed.
PT_MARKUP_ARRAY_COLS
.int GetCapabilitiesAsInt(int lGadgetCapability)
lGadgetCapability
- See PT_GADGETPROVIDER_CAPABILITIES
.
java.lang.Object GetCapabilitiesAsObject(int lGadgetCapability)
java.lang.String GetName()
java.lang.String GetDescription()
java.lang.String GetGadgetProviderCLSID()
java.lang.String GetGadgetBrowserCLSID()
java.lang.String GetImageUUID()
java.lang.String SpecificGadgetDescription(com.plumtree.openfoundation.util.IXPPropertyBag pbagConfigurationInfo)
pbagConfigurationInfo
- Configuration info.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |