lumis.service.wsrp.consumer

Class RemotePortletServiceInterface

java.lang.Object

lumis.portal.serviceinterface.GenericServiceInterface

lumis.service.wsrp.consumer.RemotePortletServiceInterface

All Implemented Interfaces:

IServiceInterface

public class RemotePortletServiceInterface
extends GenericServiceInterface

Service interface used to represent a remote portlet consumed through WSRP.

Since:

5.5.0

Version:

$Revision: 22420 $ $Date: 2019-02-19 19:21:02 +0000 (Tue, 19 Feb 2019) $

Constructor Summary

Constructors

Constructor and Description
RemotePortletServiceInterface()

Method Summary

Modifier and Type	Method and Description
void	processAction(IServiceInterfaceActionRequest interfaceRequest, IServiceInterfaceActionResponse interfaceResponse) Called by the service interface container to allow the service interface to process an action request.
void	render(IServiceInterfaceRenderRequest request, IServiceInterfaceRenderResponse response) Called by the service interface container to allow the service interface to generate the content of the response based on its current state.

Methods inherited from class lumis.portal.serviceinterface.GenericServiceInterface

instanceAdded, instanceDeleted, instanceLoaded, instanceUnLoaded, load, register, renderBefore, unload

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

RemotePortletServiceInterface

public RemotePortletServiceInterface()

Method Detail

render

public void render(IServiceInterfaceRenderRequest request,
                   IServiceInterfaceRenderResponse response)
            throws PortalException

Description copied from interface: IServiceInterface

Called by the service interface container to allow the service interface to generate the content of the response based on its current state.

Specified by:

render in interface IServiceInterface

Overrides:

render in class GenericServiceInterface

Parameters:

request - the render request

response - the render response

Throws:

ServiceInterfaceException - if the service interface has problems fulfilling the rendering request

PortalException - if the service interface is unavailable to perform render at this time

processAction

public void processAction(IServiceInterfaceActionRequest interfaceRequest,
                          IServiceInterfaceActionResponse interfaceResponse)
                   throws PortalException

Description copied from interface: IServiceInterface

Called by the service interface container to allow the service interface to process an action request. This method is called if the client request was originated by a URL created (by the service interface) with the RenderResponse.createActionURL() method.

Typically, in response to an action request, a service interface updates state based on the information sent in the action request parameters. In an action the service interface may:

• issue a redirect
• change its window state
• change its service interface mode
• modify its persistent state
• set render parameters

A client request triggered by an action URL translates into one action request and many render requests, one per service interface in the portal page. The action processing must be finished before the render requests can be issued.

Specified by:

processAction in interface IServiceInterface

Overrides:

processAction in class GenericServiceInterface

Parameters:

interfaceRequest - the action request

interfaceResponse - the action response

Throws:

ServiceInterfaceException - if the service interface has problems fulfilling the request

PortalException - if the service interface is unavailable to process the action at this time