lumis.portlet.container.service
Class PortletServiceInterface

Package class diagram package PortletServiceInterface
java.lang.Object
  extended by lumis.portal.serviceinterface.GenericServiceInterface
      extended by lumis.portlet.container.service.PortletServiceInterface
All Implemented Interfaces:
IServiceInterface

public class PortletServiceInterface
extends GenericServiceInterface

An interface that wraps a JSR-168 portlet.

Since:
4.0.7
See Also:
PortletService

Constructor Summary
PortletServiceInterface()
           
 
Method Summary
 void processAction(IServiceInterfaceActionRequest request, IServiceInterfaceActionResponse response)
          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

PortletServiceInterface

public PortletServiceInterface()
Method Detail

processAction

public void processAction(IServiceInterfaceActionRequest request,
                          IServiceInterfaceActionResponse response)
                   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:

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:
request - the action request
response - 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

render

public void render(IServiceInterfaceRenderRequest request,
                   IServiceInterfaceRenderResponse response)
            throws ServiceInterfaceException,
                   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


Lumisportal  5.5.0.091130 - Copyright © 2001-2007, Lumis. All Rights Reserved.