lumis.doui.service

Class DouiServiceInterfaceInstanceDefinition

java.lang.Object

lumis.doui.service.DouiInterfaceDefinition

lumis.doui.service.DouiServiceInterfaceInstanceDefinition

public class DouiServiceInterfaceInstanceDefinition
extends DouiInterfaceDefinition

Generates the definition for a doui service interface instance.

Since:

4.0.0

Version:

$Revision: 21314 $ $Date: 2018-05-18 21:29:35 +0000 (Fri, 18 May 2018) $

Field Summary

Fields

Modifier and Type	Field and Description
static String	PREFERENCE_PUBLISHER_FILTERS

Constructor Summary

Constructors

Constructor and Description
DouiServiceInterfaceInstanceDefinition(SessionConfig sessionConfig, Node douiServiceInterfaceDefinitionNode, String serviceInterfaceInstanceId, IDouiDefinitionProcessor processor, boolean addPublisherFiltersToSource, ITransaction transaction)
DouiServiceInterfaceInstanceDefinition(SessionConfig sessionConfig, Node douiServiceInterfaceDefinitionNode, String serviceInterfaceInstanceId, IDouiDefinitionProcessor processor, ITransaction transaction)

Method Summary

Modifier and Type	Method and Description
Node	getControlsDefinitionNode()
Node[]	getHyperlinkDefinitionNodes()
Node	getHyperlinksDefinitionNode()
Node[]	getProcessActionDefinitionNodes(String processActionId)
Node	getProcessActionsDefinitionNode()
Node[]	getRenderActionDefinitionNodes(String renderActionId)
Node[]	getSourceDefinitionNodes()
boolean	hasLogicTags() Determines if the current service interface definition node contains doui logic tags.
protected void	insertCustomFilters(Node newSourceNode, Node interfaceSourceNode)
protected void	insertCustomMaxRows(Node newSourceNode, Node interfaceSourceNode)
protected void	insertCustomOrderBy(Node newSourceNode, Node interfaceSourceNode)
boolean	isElIgnored() Indicates if this doui definition may contain ELs that must be evaluated.
protected void	mergeFields(Node mergeFromSourceNode, Node mergeToSourceNode)
static void	mergeSourceFields(Node mergeFromSourceNode, Node mergeToSourceNode) Merges the fields in the mergeFromSourceNode to the mergeToSourceNode.
void	processNodes(IDouiDefinitionProcessor processor, Node douiInterfaceDefinitionNode) Allows the processing of the doui definition stored in this instance.

Methods inherited from class lumis.doui.service.DouiInterfaceDefinition

getFilterNodes, insertDependantFields, mergeFieldNodes, mergePostLoadProcessors, mergeSearch, mergeSourceDefinition, mergeSourceDefinitions

Methods inherited from class java.lang.Object

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

Field Detail

PREFERENCE_PUBLISHER_FILTERS

public static final String PREFERENCE_PUBLISHER_FILTERS

See Also:

Constant Field Values

Constructor Detail

DouiServiceInterfaceInstanceDefinition

public DouiServiceInterfaceInstanceDefinition(SessionConfig sessionConfig,
                                              Node douiServiceInterfaceDefinitionNode,
                                              String serviceInterfaceInstanceId,
                                              IDouiDefinitionProcessor processor,
                                              ITransaction transaction)
                                       throws PortalException

Throws:

PortalException

DouiServiceInterfaceInstanceDefinition

public DouiServiceInterfaceInstanceDefinition(SessionConfig sessionConfig,
                                              Node douiServiceInterfaceDefinitionNode,
                                              String serviceInterfaceInstanceId,
                                              IDouiDefinitionProcessor processor,
                                              boolean addPublisherFiltersToSource,
                                              ITransaction transaction)
                                       throws PortalException

Throws:

PortalException

Method Detail

getControlsDefinitionNode

public Node getControlsDefinitionNode()
                               throws PortalException

Throws:

PortalException

processNodes

public void processNodes(IDouiDefinitionProcessor processor,
                         Node douiInterfaceDefinitionNode)
                  throws PortalException

Allows the processing of the doui definition stored in this instance.

Parameters:

processor - the processor that will be called.

Throws:

PortalException

Since:

4.0.7

isElIgnored

public boolean isElIgnored()

Indicates if this doui definition may contain ELs that must be evaluated.

Returns:

false if ELs must be evaluated, or true if it must be ignored and not evaluated.

Since:

4.0.7

getSourceDefinitionNodes

public Node[] getSourceDefinitionNodes()

getHyperlinksDefinitionNode

public Node getHyperlinksDefinitionNode()
                                 throws PortalException

Throws:

PortalException

getHyperlinkDefinitionNodes

public Node[] getHyperlinkDefinitionNodes()
                                   throws PortalException

Throws:

PortalException

getProcessActionsDefinitionNode

public Node getProcessActionsDefinitionNode()
                                     throws PortalException

Throws:

PortalException

getProcessActionDefinitionNodes

public Node[] getProcessActionDefinitionNodes(String processActionId)
                                       throws PortalException

Throws:

PortalException

getRenderActionDefinitionNodes

public Node[] getRenderActionDefinitionNodes(String renderActionId)
                                      throws PortalException

Throws:

PortalException

mergeSourceFields

public static void mergeSourceFields(Node mergeFromSourceNode,
                                     Node mergeToSourceNode)
                              throws PortalException

Merges the fields in the mergeFromSourceNode to the mergeToSourceNode.

Parameters:

mergeFromSourceNode - the source node from which the merge will be done.

mergeToSourceNode - the source node to which the merge will be done. This node will be modified by the merge.

Throws:

PortalException

Since:

4.0.5

mergeFields

protected void mergeFields(Node mergeFromSourceNode,
                           Node mergeToSourceNode)
                    throws PortalException

Overrides:

mergeFields in class DouiInterfaceDefinition

Throws:

PortalException

insertCustomFilters

protected void insertCustomFilters(Node newSourceNode,
                                   Node interfaceSourceNode)
                            throws PortalException

Overrides:

insertCustomFilters in class DouiInterfaceDefinition

Throws:

PortalException

insertCustomMaxRows

protected void insertCustomMaxRows(Node newSourceNode,
                                   Node interfaceSourceNode)
                            throws PortalException

Overrides:

insertCustomMaxRows in class DouiInterfaceDefinition

Throws:

PortalException

insertCustomOrderBy

protected void insertCustomOrderBy(Node newSourceNode,
                                   Node interfaceSourceNode)
                            throws PortalException

Overrides:

insertCustomOrderBy in class DouiInterfaceDefinition

Throws:

PortalException

hasLogicTags

public boolean hasLogicTags()

Determines if the current service interface definition node contains doui logic tags.

Returns:

If the current service interface definitinon node contains doui logic tags.

Since:

5.6.0