Package lumis.content.service

Class ContentServiceInterface

java.lang.Object

lumis.portal.serviceinterface.GenericServiceInterface

lumis.doui.service.DouiServiceInterface

lumis.content.service.ContentServiceInterface

All Implemented Interfaces:

IDouiServiceInterface, IServiceInterface, IServiceInterfaceMenu

Direct Known Subclasses:

ChatRoomParticipateInterface, ContentAdministrationPropertyPageServiceInterface, ContentDetailsServiceInterface, ContentGenericListServiceInterface

@StableMinor(version="16.1",
             sinceVersion="4.0")
public class ContentServiceInterface
extends DouiServiceInterface

Interface for content service interfaces

Since:

4.0.0

Version:

$Revision: 26157 $ $Date: 2024-01-13 11:35:03 -0300 (Sat, 13 Jan 2024) $

Field Summary

Fields inherited from class lumis.doui.service.DouiServiceInterface

VALIDATE_RENDER_PARAMETER

Constructor Summary

Constructors

Constructor	Description
ContentServiceInterface()

Method Summary

Modifier and Type	Method	Description
protected boolean	addDefaultOrderBy(org.w3c.dom.Node serviceInterfaceSourceNode, org.w3c.dom.Node serviceDouiDefinitionNode, org.w3c.dom.Node serviceInterfaceXmlNode)
protected java.lang.String	getCustomMenu(SessionConfig sessionConfig, ServiceInterfaceInstanceConfig config, ITransaction transaction)
protected java.lang.String	getDefaultStyle()
java.lang.String	getRepositoryMenus(SessionConfig sessionConfig, ServiceInterfaceInstanceConfig config, ITransaction transaction)
void	load(ServiceInterfaceConfig config)	Called by the service interface container to indicate to a service interface that the service interface is being placed into service.
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, addDefaultPostLoadProcessors, addDefaultProcessActions, addDefaultSources, addDetailsHyperLink, addPrimaryKeyFilter, getContext, getInterfaceSourceFieldsNode, getMenu, initDouiContext, loadFromRequest, loadSources, processAction, processActions, register, renderBefore, renderData, validate

Methods inherited from class lumis.portal.serviceinterface.GenericServiceInterface

calculateIsRequestInitializerSupported, instanceAdded, instanceDeleted, instanceLoaded, instanceUnLoaded, isRequestInitializerSupported, 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

ContentServiceInterface

public ContentServiceInterface()

Method Detail

load

public void load(ServiceInterfaceConfig config)
          throws ServiceInterfaceException,
                 PortalException

Description copied from interface: IServiceInterface

Called by the service interface container to indicate to a service interface that the service interface is being placed into service.

The service interface container calls the init method exactly once after instantiating the service interface. The init method must complete successfully before the service interface can receive any requests.

The service interface container cannot place the service interface into service if the init method

1. Throws a ServiceInterfaceException
2. Does not return within a time period defined by the service interface container.

Specified by:

load in interface IServiceInterface

Overrides:

load in class GenericServiceInterface

Parameters:

config - a ServiceInterfaceConfig object containing the service interface's configuration and initialization parameters

Throws:

ServiceInterfaceException - if an exception has occurred that interferes with the service interface's normal operation.

PortalException - if the service interface cannot perform the initialization at this time.

getDefaultStyle

protected java.lang.String getDefaultStyle()

Overrides:

getDefaultStyle in class DouiServiceInterface

getCustomMenu

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

Overrides:

getCustomMenu in class DouiServiceInterface

Throws:

PortalException

getRepositoryMenus

public java.lang.String getRepositoryMenus(SessionConfig sessionConfig,
                                           ServiceInterfaceInstanceConfig config,
                                           ITransaction transaction)
                                    throws PortalException

Overrides:

getRepositoryMenus in class DouiServiceInterface

Throws:

PortalException

addDefaultOrderBy

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

Overrides:

addDefaultOrderBy in class DouiServiceInterface

Throws:

PortalException

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