|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
public interface PortletDriver
The portlet driver is a wrapper for all action which can be performed on an portlet. There is one portlet driver for all instances of an portlet.
| Method Summary | |
|---|---|
PortletContext |
clonePortlet(java.lang.String userID)
Clone the portlet |
DestroyPortletsResponse |
destroyPortlets(java.lang.String[] portletHandles,
java.lang.String userID)
Destroy the producer portlets specified in the entiyHandles array. |
MarkupResponse |
getMarkup(MarkupRequest markupRequest,
java.lang.String userID)
This method is used to retrieve the markup generated by the portlet instance. |
WSRPPortlet |
getPortlet()
Get the portlet this driver is bound to. |
PortletDescriptionResponse |
getPortletDescription(java.lang.String userID,
java.lang.String[] desiredLocales)
Fetches information about the portlet from the producer. |
PropertyList |
getPortletProperties(java.lang.String[] names,
java.lang.String userID)
Get the current values of the properties with the given names. |
PortletPropertyDescriptionResponse |
getPortletPropertyDescription(java.lang.String userID)
Fetches all published properties of an remote portlet. |
void |
initCookie()
|
BlockingInteractionResponse |
performBlockingInteraction(InteractionRequest actionRequest,
java.lang.String userID)
This method is used to perform a blocking interaction on the portlet instance. |
ReturnAny |
releaseSessions(java.lang.String[] sessionIDs,
java.lang.String userID)
Inform the producer that the sessions specified in the sessionIDs array will no longer be used by the consumer and can therefor be released. |
PortletContext |
setPortletProperties(PropertyList properties,
java.lang.String userID)
Set the portlet properties specified in the property list |
| Method Detail |
|---|
WSRPPortlet getPortlet()
MarkupResponse getMarkup(MarkupRequest markupRequest,
java.lang.String userID)
throws WSRPException
markupRequest - The markup request
WSRPException
BlockingInteractionResponse performBlockingInteraction(InteractionRequest actionRequest,
java.lang.String userID)
throws WSRPException
actionRequest - The interaction request
WSRPException
PortletContext clonePortlet(java.lang.String userID)
throws WSRPException
WSRPException
void initCookie()
throws WSRPException
WSRPException
DestroyPortletsResponse destroyPortlets(java.lang.String[] portletHandles,
java.lang.String userID)
throws WSRPException
WSRPException
ReturnAny releaseSessions(java.lang.String[] sessionIDs,
java.lang.String userID)
throws WSRPException
WSRPException
PortletDescriptionResponse getPortletDescription(java.lang.String userID,
java.lang.String[] desiredLocales)
throws WSRPException
userID - is used to get the user context of the user from the user registrydesiredLocales - Array of locales the description should be provided
WSRPException
PortletPropertyDescriptionResponse getPortletPropertyDescription(java.lang.String userID)
throws WSRPException
userID - The ID of the user this request is done for
WSRPException
PropertyList getPortletProperties(java.lang.String[] names,
java.lang.String userID)
throws WSRPException
names - The names of the propertiesuserID - The ID of the user is used to get the user context
WSRPException
PortletContext setPortletProperties(PropertyList properties,
java.lang.String userID)
throws WSRPException
properties - List of properties to be set.userID - The ID of the user is used to get the user context
WSRPException
|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||