Package lumis.service.search
Class SearchPropertiesInterfaces
- java.lang.Object
-
- lumis.portal.serviceinterface.GenericServiceInterface
-
- lumis.doui.service.DouiServiceInterface
-
- lumis.service.search.SearchPropertiesInterfaces
-
- All Implemented Interfaces:
IDouiServiceInterface
,IServiceInterface
,IServiceInterfaceMenu
public class SearchPropertiesInterfaces extends DouiServiceInterface
DouiServiceInterface
extension that validates user permissions on service instance that is going to be altered.- Since:
- 6.0.0
- Version:
- $Revision: 17692 $ $Date: 2015-08-20 14:22:38 -0300 (Thu, 20 Aug 2015) $
-
-
Field Summary
-
Fields inherited from class lumis.doui.service.DouiServiceInterface
VALIDATE_RENDER_PARAMETER
-
-
Constructor Summary
Constructors Constructor Description SearchPropertiesInterfaces()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description 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.doui.service.DouiServiceInterface
addDefaultControls, addDefaultDouiDefinitionValues, addDefaultFields, addDefaultFilters, addDefaultHyperLinks, addDefaultInterfaceDouiDefinitionNode, addDefaultMaxRows, addDefaultOrderBy, addDefaultPostLoadProcessors, addDefaultProcessActions, addDefaultSources, addDetailsHyperLink, addPrimaryKeyFilter, getContext, getCustomMenu, getDefaultStyle, getInterfaceSourceFieldsNode, getMenu, getRepositoryMenus, initDouiContext, loadFromRequest, loadSources, processActions, register, renderBefore, renderData, validate
-
Methods inherited from class lumis.portal.serviceinterface.GenericServiceInterface
instanceAdded, instanceDeleted, instanceLoaded, instanceUnLoaded, load, unload
-
-
-
-
Method Detail
-
render
public void render(IServiceInterfaceRenderRequest request, IServiceInterfaceRenderResponse response) throws ServiceInterfaceException, PortalException
Description copied from class:DouiServiceInterface
Called by the service interface container to allow the service interface to generate the content of the response based on its current state.Executes the following steps (implemented by the referenced methods):
- Create the Doui context:
DouiServiceInterface.getContext(IServiceInterfaceRequest, IServiceInterfaceResponse, ITransaction)
- Initialize the Doui context:
DouiServiceInterface.initDouiContext(DouiContext)
- Load information from request:
DouiServiceInterface.loadFromRequest(DouiContext)
- Perform validations:
DouiServiceInterface.validate(DouiContext)
- Load sources:
DouiServiceInterface.loadSources(DouiContext)
- Render data:
DouiServiceInterface.renderData(IServiceInterfaceRenderResponse, DouiContext)
- Specified by:
render
in interfaceIServiceInterface
- Overrides:
render
in classDouiServiceInterface
- Parameters:
request
- the render requestresponse
- the render response- Throws:
ServiceInterfaceException
- if the service interface has problems fulfilling the rendering requestPortalException
- if the service interface is unavailable to perform render at this time
- Create the Doui context:
-
processAction
public void processAction(IServiceInterfaceActionRequest request, IServiceInterfaceActionResponse response) throws ServiceInterfaceException, PortalException
Description copied from class:DouiServiceInterface
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 theRenderResponse.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.
Execute the following steps (implemented by the referenced methods):
- Create the Doui context:
DouiServiceInterface.getContext(IServiceInterfaceRequest, IServiceInterfaceResponse, ITransaction)
- Initialize the Doui context:
DouiServiceInterface.initDouiContext(DouiContext)
- Load information from request:
DouiServiceInterface.loadFromRequest(DouiContext)
- Perform validations:
DouiServiceInterface.validate(DouiContext)
- Process actions:
DouiServiceInterface.processActions(DouiContext)
- Specified by:
processAction
in interfaceIServiceInterface
- Overrides:
processAction
in classDouiServiceInterface
- Parameters:
request
- the action requestresponse
- the action response- Throws:
ServiceInterfaceException
- if the service interface has problems fulfilling the requestPortalException
- if the service interface is unavailable to process the action at this time
-
-