Package lumis.service.doui.htmlsnippet

Class HtmlSnippetDouiInterface

java.lang.Object

lumis.portal.serviceinterface.GenericServiceInterface

lumis.doui.service.DouiServiceInterface

lumis.service.doui.htmlsnippet.HtmlSnippetDouiInterface

All Implemented Interfaces:

IDouiServiceInterface, IServiceInterface, IServiceInterfaceMenu

public class HtmlSnippetDouiInterface
extends DouiServiceInterface

Interface implementation of interface type lum_doui used by htmlsnippet service to include permissions check.

Since:

15.0.0

Version:

$Revision: 25304 $ $Date: 2022-10-22 22:51:05 -0300 (Sat, 22 Oct 2022) $

Field Summary

Fields inherited from class lumis.doui.service.DouiServiceInterface

VALIDATE_RENDER_PARAMETER

Constructor Summary

Constructors

Constructor	Description
HtmlSnippetDouiInterface()

Method Summary

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

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

Constructor Detail

HtmlSnippetDouiInterface

public HtmlSnippetDouiInterface()

Method Detail

render

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

Overrides:

render in class DouiServiceInterface

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 request,
                          IServiceInterfaceActionResponse response)
                   throws 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 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.

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 interface IServiceInterface

Overrides:

processAction in class DouiServiceInterface

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