Package lumis.service.doui.positionfield

Class PositionFieldOrderInterface

java.lang.Object

lumis.portal.serviceinterface.GenericServiceInterface

lumis.doui.service.DouiServiceInterface

lumis.doui.service.DouiAdministrationPropertyPageServiceInterface

lumis.service.doui.positionfield.PositionFieldOrderInterface

All Implemented Interfaces:

IDouiServiceInterface, IServiceInterface, IServiceInterfaceMenu

public class PositionFieldOrderInterface
extends DouiAdministrationPropertyPageServiceInterface

Implementation of order interface.

Since:

10.3.0

Version:

$Revision: 25270 $ $Date: 2022-10-04 11:58:27 -0300 (Tue, 04 Oct 2022) $

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	INTERFACE_ID	The identifier for this interface.
static java.lang.String	PARAMETER_POSITION_FIELD_GROUP	Parameter expected to contain the value used for filtering data by the position grouped by field.
static java.lang.String	PARAMETER_POSITION_FIELD_SERVICE_INSTANCE_ID	Parameter expected to contain the position field's service instance identifier.
static java.lang.String	PARAMETER_POSITION_FIELD_SERVICE_INTERFACE_INSTANCE_ID	Parameter expected to contain the position field's service interface instance identifier.
static java.lang.String	PARAMETER_POSITION_FIELD_SOURCE_ID	Parameter expected to contain the position field's source identifier.

Fields inherited from class lumis.doui.service.DouiServiceInterface

VALIDATE_RENDER_PARAMETER

Constructor Summary

Constructors

Constructor	Description
PositionFieldOrderInterface()

Method Summary

Modifier and Type	Method	Description
protected void	initDouiContext(DouiContext douiContext)	Initialize the Doui context, source container and control container.
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.DouiAdministrationPropertyPageServiceInterface

getCustomMenu, register, setIsAdministrationProperty, setIsRuntimeOnlyProperty

Methods inherited from class lumis.doui.service.DouiServiceInterface

addDefaultControls, addDefaultDouiDefinitionValues, addDefaultFields, addDefaultFilters, addDefaultHyperLinks, addDefaultInterfaceDouiDefinitionNode, addDefaultMaxRows, addDefaultOrderBy, addDefaultPostLoadProcessors, addDefaultProcessActions, addDefaultSources, addDetailsHyperLink, addPrimaryKeyFilter, getContext, getDefaultStyle, getInterfaceSourceFieldsNode, getMenu, getRepositoryMenus, loadFromRequest, loadSources, processActions, 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

Field Detail

INTERFACE_ID

public static final java.lang.String INTERFACE_ID

The identifier for this interface.

Since:

10.3.0

See Also:

Constant Field Values

PARAMETER_POSITION_FIELD_SERVICE_INSTANCE_ID

public static final java.lang.String PARAMETER_POSITION_FIELD_SERVICE_INSTANCE_ID

Parameter expected to contain the position field's service instance identifier.

Since:

10.3.0

See Also:

Constant Field Values

PARAMETER_POSITION_FIELD_SERVICE_INTERFACE_INSTANCE_ID

public static final java.lang.String PARAMETER_POSITION_FIELD_SERVICE_INTERFACE_INSTANCE_ID

Parameter expected to contain the position field's service interface instance identifier.

Since:

10.4.0

See Also:

Constant Field Values

PARAMETER_POSITION_FIELD_SOURCE_ID

public static final java.lang.String PARAMETER_POSITION_FIELD_SOURCE_ID

Parameter expected to contain the position field's source identifier.

Since:

10.3.0

See Also:

Constant Field Values

PARAMETER_POSITION_FIELD_GROUP

public static final java.lang.String PARAMETER_POSITION_FIELD_GROUP

Parameter expected to contain the value used for filtering data by the position grouped by field.

Since:

10.3.0

See Also:

Constant Field Values

Constructor Detail

PositionFieldOrderInterface

public PositionFieldOrderInterface()

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

initDouiContext

protected void initDouiContext(DouiContext douiContext)
                        throws PortalException

Description copied from class: DouiServiceInterface

Initialize the Doui context, source container and control container.

Overrides:

initDouiContext in class DouiServiceInterface

Throws:

PortalException - if an error occur during the initialization process.