com.hp.ucmdb.api.view.foldingdefinition

Interface SyntheticFDN

All Superinterfaces:

FoldingDefinitionNode, SupportsClientProperties<FoldingDefinitionNode>, SupportsInvisibility<FoldingDefinitionNode>

All Known Subinterfaces:

GroupByAttributeSyntheticFDN, GroupByTypeSyntheticFDN

public interface SyntheticFDN
extends FoldingDefinitionNode

This node adds predefined nodes to each of its parents. The node label will be the predefined label, unless modified by sub classes.

By default, if this node has no children in the results tree, it does not add the label node to it either. This behavior can be overridden using the withAppearEvenIfEmptyFlag(boolean).

Restriction:

1. A synthetic node must have a defining query based FDN, set using the todo: descendant of syn chain withDefiningQueryBasedFDNName(String). This query based FDN must be a descendant of the synthetic node
   

The synthetic node function and appear-even-if-empty calculation will be calculated based on the the CIs from that query based FDN.

Defaults:

• If a query based FDN is added to the synthetic node subtree before calling withDefiningQueryBasedFDNName, the synthetic node will consider it the defining query based FDN. Of course, this can later be changed using withDefiningQueryBasedFDNName.
• The default label is the node name, unless overridden by extending interfaces.

Note: While it is possible to add other nodes (query based and synthetic) as children, they will only appear if the relevant defining query based FDN results are not empty.

Since:

UCMDB 9.0

Method Summary

Modifier and Type	Method and Description
<FDN extends FoldingDefinitionNode> FDN	addChild(FDN foldingDefinitionNode) Appends a child to this FDN as the last child.
<FDN extends FoldingDefinitionNode> FDN	addChild(FDN foldingDefinitionNode, int index) Inserts a child to this FDN at the index location.
boolean	appearEvenIfEmpty() True iff this node should appear even if it has no children in the results tree.
String	definingQueryBasedFDNName() The defining QueryBasedFDN for this node.
String	label() The base label for this node.
SyntheticFDN	withAppearEvenIfEmptyFlag(boolean appearEvenIfEmpty) Sets if this node should appear even if it has no children in the results tree.
SyntheticFDN	withDefiningQueryBasedFDNName(String definingQueryBasedFDNName) Sets the defining QueryBasedFDN for functional and appear-even-if-empty calculations.
SyntheticFDN	withLabel(String label) The base label for this node.

Methods inherited from interface com.hp.ucmdb.api.view.foldingdefinition.FoldingDefinitionNode

addSortingRule, addSortingRule, addViewAttribute, asQueryNodeBasedFDN, asSyntheticNode, children, definition, name, parent, root, sortingRules, viewAttributes

Methods inherited from interface com.hp.ucmdb.api.util.SupportsClientProperties

clientProperties, clientProperty, usedNamespaces, withClientProperty

Methods inherited from interface com.hp.ucmdb.api.topology.SupportsInvisibility

invisible, isInvisible

Method Detail

addChild

<FDN extends FoldingDefinitionNode> FDN addChild(FDN foldingDefinitionNode)

Appends a child to this FDN as the last child.

Specified by:

addChild in interface FoldingDefinitionNode

Returns:

the child just added.

addChild

<FDN extends FoldingDefinitionNode> FDN addChild(FDN foldingDefinitionNode,
                                                 int index)

Inserts a child to this FDN at the index location.

Specified by:

addChild in interface FoldingDefinitionNode

Returns:

the child just added.

label

String label()

The base label for this node. If not modified, will be used for the label node.

withLabel

SyntheticFDN withLabel(String label)

The base label for this node. If not modified, will be used for the label node.

Returns:

this SyntheticFDN.

appearEvenIfEmpty

boolean appearEvenIfEmpty()

True iff this node should appear even if it has no children in the results tree.

withAppearEvenIfEmptyFlag

SyntheticFDN withAppearEvenIfEmptyFlag(boolean appearEvenIfEmpty)

Sets if this node should appear even if it has no children in the results tree.

Returns:

this SyntheticFDN.

withDefiningQueryBasedFDNName

SyntheticFDN withDefiningQueryBasedFDNName(String definingQueryBasedFDNName)

Sets the defining QueryBasedFDN for functional and appear-even-if-empty calculations.

definingQueryBasedFDNName

String definingQueryBasedFDNName()

The defining QueryBasedFDN for this node.