Package lumis.content.service

Class ContentDetailsServiceInterface

java.lang.Object

lumis.portal.serviceinterface.GenericServiceInterface

lumis.doui.service.DouiServiceInterface

lumis.content.service.ContentServiceInterface

lumis.content.service.ContentDetailsServiceInterface

All Implemented Interfaces:

IDouiServiceInterface, IServiceInterface, IServiceInterfaceMenu

Direct Known Subclasses:

HtmlContentDetailsInterface

public class ContentDetailsServiceInterface
extends ContentServiceInterface

Since:

4.0.0

Version:

$Revision: 25455 $ $Date: 2023-02-15 13:42:57 -0300 (Wed, 15 Feb 2023) $

Field Summary

Fields inherited from class lumis.doui.service.DouiServiceInterface

VALIDATE_RENDER_PARAMETER

Constructor Summary

Constructors

Constructor	Description
ContentDetailsServiceInterface()

Method Summary

Modifier and Type	Method	Description
protected boolean	addDefaultControls(org.w3c.dom.Node serviceInterfaceDouiDefinitionNode, org.w3c.dom.Node serviceDouiDefinitionNode, org.w3c.dom.Node serviceInterfaceXmlNode)
protected boolean	addDefaultFields(org.w3c.dom.Node serviceInterfaceSourceNode, org.w3c.dom.Node serviceDouiDefinitionNode, org.w3c.dom.Node serviceInterfaceXmlNode)
protected boolean	addDefaultMaxRows(org.w3c.dom.Node serviceInterfaceSourceNode, org.w3c.dom.Node serviceDouiDefinitionNode, org.w3c.dom.Node serviceInterfaceXmlNode)
protected boolean	calculateIsRequestInitializerSupported(ServiceInterfaceConfig serviceInterface)	Calculates whether the given service interface supports request initialization.
protected java.lang.String	getCustomMenu(SessionConfig sessionConfig, ServiceInterfaceInstanceConfig config, ITransaction transaction)
void	initializeRequest(IServiceInterfaceRequest originalRequest, IRequestInitializer requestInitializer)	Initializes the request by changing the given request initializer.
void	register(SessionConfig sessionConfig, org.w3c.dom.Node serviceInterfaceXmlNode, ITransaction transaction)	Called by the service interface manager when a service interface definition is registered.
protected void	renderData(IServiceInterfaceRenderResponse response, DouiContext douiContext)	Render data.
protected void	setPreviewSupportedProperty(SessionConfig sessionConfig, org.w3c.dom.Node serviceInterfaceXmlNode, ITransaction transaction)

Methods inherited from class lumis.content.service.ContentServiceInterface

addDefaultOrderBy, getDefaultStyle, getRepositoryMenus, load, render

Methods inherited from class lumis.doui.service.DouiServiceInterface

addDefaultDouiDefinitionValues, addDefaultFilters, addDefaultHyperLinks, addDefaultInterfaceDouiDefinitionNode, addDefaultPostLoadProcessors, addDefaultProcessActions, addDefaultSources, addDetailsHyperLink, addPrimaryKeyFilter, getContext, getInterfaceSourceFieldsNode, getMenu, initDouiContext, loadFromRequest, loadSources, processAction, processActions, renderBefore, validate

Methods inherited from class lumis.portal.serviceinterface.GenericServiceInterface

instanceAdded, instanceDeleted, instanceLoaded, instanceUnLoaded, isRequestInitializerSupported, unload

Methods inherited from class java.lang.Object

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

Constructor Detail

ContentDetailsServiceInterface

public ContentDetailsServiceInterface()

Method Detail

getCustomMenu

protected java.lang.String getCustomMenu(SessionConfig sessionConfig,
                                         ServiceInterfaceInstanceConfig config,
                                         ITransaction transaction)
                                  throws PortalException

Overrides:

getCustomMenu in class ContentServiceInterface

Throws:

PortalException

register

public void register(SessionConfig sessionConfig,
                     org.w3c.dom.Node serviceInterfaceXmlNode,
                     ITransaction transaction)
              throws PortalException

Description copied from interface: IServiceInterface

Called by the service interface manager when a service interface definition is registered. This method allows the Service Interface implementation to set its default values into the service interface definition xml.

Specified by:

register in interface IServiceInterface

Overrides:

register in class DouiServiceInterface

Parameters:

sessionConfig - TODO

transaction - TODO

Throws:

PortalException

setPreviewSupportedProperty

protected void setPreviewSupportedProperty(SessionConfig sessionConfig,
                                           org.w3c.dom.Node serviceInterfaceXmlNode,
                                           ITransaction transaction)
                                    throws PortalException

Throws:

PortalException

addDefaultMaxRows

protected boolean addDefaultMaxRows(org.w3c.dom.Node serviceInterfaceSourceNode,
                                    org.w3c.dom.Node serviceDouiDefinitionNode,
                                    org.w3c.dom.Node serviceInterfaceXmlNode)
                             throws PortalException

Overrides:

addDefaultMaxRows in class DouiServiceInterface

Throws:

PortalException

addDefaultFields

protected boolean addDefaultFields(org.w3c.dom.Node serviceInterfaceSourceNode,
                                   org.w3c.dom.Node serviceDouiDefinitionNode,
                                   org.w3c.dom.Node serviceInterfaceXmlNode)
                            throws PortalException

Overrides:

addDefaultFields in class DouiServiceInterface

Throws:

PortalException

addDefaultControls

protected boolean addDefaultControls(org.w3c.dom.Node serviceInterfaceDouiDefinitionNode,
                                     org.w3c.dom.Node serviceDouiDefinitionNode,
                                     org.w3c.dom.Node serviceInterfaceXmlNode)
                              throws PortalException

Overrides:

addDefaultControls in class DouiServiceInterface

Throws:

PortalException

renderData

protected void renderData(IServiceInterfaceRenderResponse response,
                          DouiContext douiContext)
                   throws PortalException

Description copied from class: DouiServiceInterface

Render data.

Overrides:

renderData in class DouiServiceInterface

douiContext - DouiContext instance.

Throws:

PortalException - if an error occur during the render process.

calculateIsRequestInitializerSupported

protected boolean calculateIsRequestInitializerSupported(ServiceInterfaceConfig serviceInterface)
                                                  throws PortalException

Description copied from class: GenericServiceInterface

Calculates whether the given service interface supports request initialization.

Overrides:

calculateIsRequestInitializerSupported in class GenericServiceInterface

Parameters:

serviceInterface - the service interface

Returns:

whether the given service interface supports request initialization.

Throws:

PortalException

initializeRequest

public void initializeRequest(IServiceInterfaceRequest originalRequest,
                              IRequestInitializer requestInitializer)
                       throws PortalException

Description copied from interface: IServiceInterface

Initializes the request by changing the given request initializer.

Parameters:

originalRequest - the original request

requestInitializer - the request initializer

Throws:

PortalException