Package lumis.service.doui.ai
Class AiAssistantServiceInterface
- java.lang.Object
-
- lumis.portal.serviceinterface.GenericServiceInterface
-
- lumis.doui.service.DouiServiceInterface
-
- lumis.service.doui.ai.AiAssistantServiceInterface
-
- All Implemented Interfaces:
IDouiServiceInterface
,IServiceInterface
,IServiceInterfaceMenu
public class AiAssistantServiceInterface extends DouiServiceInterface
Ai Assistant service interface.- Since:
- 16.0.0
- Version:
- $Revision: 25809 $ $Date: 2023-07-04 15:23:22 -0300 (Tue, 04 Jul 2023) $
-
-
Field Summary
-
Fields inherited from class lumis.doui.service.DouiServiceInterface
VALIDATE_RENDER_PARAMETER
-
-
Constructor Summary
Constructors Constructor Description AiAssistantServiceInterface()
-
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.protected void
renderData(IServiceInterfaceRenderResponse response, DouiContext douiContext)
Render data.-
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, render, renderBefore, validate
-
Methods inherited from class lumis.portal.serviceinterface.GenericServiceInterface
calculateIsRequestInitializerSupported, instanceAdded, instanceDeleted, instanceLoaded, instanceUnLoaded, isRequestInitializerSupported, load, unload
-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface lumis.portal.serviceinterface.IServiceInterface
initializeRequest
-
-
-
-
Method Detail
-
renderData
protected void renderData(IServiceInterfaceRenderResponse response, DouiContext douiContext) throws PortalException
Description copied from class:DouiServiceInterface
Render data.- Overrides:
renderData
in classDouiServiceInterface
douiContext
- DouiContext instance.- Throws:
PortalException
- if an error occur during the render process.
-
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
-
-