com.hp.ucmdb.api.view.result

Interface ViewResultTreeNode

All Superinterfaces:

SupportsClientProperties<ViewResultTreeNode>

public interface ViewResultTreeNode
extends SupportsClientProperties<ViewResultTreeNode>

A base interface for all view results tree nodes.

This interface defines a basic 2-way tree structure.

Client properties are copied from the client properties of the folding definition nodes in the view definition that this tree node originated from (see viewDefinitionNodeNames(). These client properties are not modifiable.

Since:

UCMDB 9.0

Method Summary

Modifier and Type	Method and Description
List<? extends ViewResultTreeNode>	children() The ordered list of children of this node.
TopologyCI	ci() The CI associated with this view result tree node.
Set<FullyQualifiedName>	fullyQualifiedViewDefinitionNodeNames() Returns the fully qualified node names that this tree node originated from.
String	iconName() Returns the icon name for this node.
ViewResultTreeNodeID	id() The ID of this node.
boolean	isOrpahnCI()
String	label() Returns the label for this node.
String	note() For CI based nodes, returns the note, if any is attached to the CI.
ViewResultTreeNode	parent() The parent of this node.
Set<String>	viewDefinitionNodeNames() Return the view definition nodes names that this tree node originated from.
List<Property>	viewProperties() Returns the view properties collection.

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

clientProperties, clientProperty, usedNamespaces, withClientProperty

Method Detail

id

ViewResultTreeNodeID id()

The ID of this node. Node IDs are unique in a view, but not across views.

parent

ViewResultTreeNode parent()

The parent of this node. May be null for root nodes.

children

List<? extends ViewResultTreeNode> children()

The ordered list of children of this node. May be empty if there are no children. Note: This is in fact an ordered set - the same item may only appear once.

ci

TopologyCI ci()

The CI associated with this view result tree node. Note: This may be null for nodes created from synthetic definition nodes (such as groups).

label

String label()

Returns the label for this node. The label is the label of the CI, if it exists, or a label dervied from the synthetic node.

This feature may be affected by the options object.

iconName

String iconName()

Returns the icon name for this node.

This feature may be affected by the options object.

note

String note()

For CI based nodes, returns the note, if any is attached to the CI. Otherwise, returns empty string.

This feature may be affected by the options object.

viewDefinitionNodeNames

Set<String> viewDefinitionNodeNames()

Return the view definition nodes names that this tree node originated from.

Note: This method will not distinct between name spaces in case of multiple view definitions. In that case, use fullyQualifiedViewDefinitionNodeNames() instead.

See Also:

fullyQualifiedViewDefinitionNodeNames()

fullyQualifiedViewDefinitionNodeNames

Set<FullyQualifiedName> fullyQualifiedViewDefinitionNodeNames()

Returns the fully qualified node names that this tree node originated from. The node names will always be in the form of [viewName,...,viewName,nodeName] (elements 0..n-1 are a path of view names, element n is the node name).

See Also:

viewDefinitionNodeNames()

isOrpahnCI

boolean isOrpahnCI()

viewProperties

@NotFinalAPI
List<Property> viewProperties()

Returns the view properties collection.

View properties are calculated by the view attributes of all the view definition nodes that this tree node originated from. The view properties are ordered by the order of the view attributes of the definition nodes.

This feature may be affected by the options object.

Returns:

the view properties list.