com.hp.ucmdb.api.view
Interface RuleBasedViewDefinition

All Superinterfaces:

BundledResource<ViewDefinition>, SupportsClientProperties<ViewDefinition>, ViewDefinition<RuleBasedViewDefinition>

@NotFinalAPI
public interface RuleBasedViewDefinition
extends ViewDefinition<RuleBasedViewDefinition>

A view based on a query name and rules defining the desired result hierarchy.

The query the view is based on defines what data (CIs) are included in the view. The folding rules define how that data is presented in a tree-like structure, that is, how to transform the query result to a tree.

Cycles are not handled by views of this type. If an unresolvable cycle occurs, it is ignored and not presented in the view result at all. This can be verified by traversing the entire view result and comparing the CIs from the view topology against CIs seen in the view.

CIs that are not directly handled by one of the rules do not appear in the view result.

Since:

UCMDB 9.0

Method Summary

ViewClassBasedFoldingRule	addClassBasedFoldingRules() Adds and assigns a new class-based folding rule to the view.
java.util.List<ViewClassBasedFoldingRule>	classBasedFoldingRules() Returns the list of class-based folding rules assigned to this view.
RuleBasedViewDefinition	withQueryName(java.lang.String queryName) Changes the query name this view is based on.

Methods inherited from interface com.hp.ucmdb.api.view.ViewDefinition

asPerspectiveBasedViewReferenceDefinition, asRuleBasedViewDefinition, asSingleViewReference, asViewWithFoldingDefinition, description, name, queryName, toView, viewType, withDescription

Methods inherited from interface com.hp.ucmdb.api.bundles.BundledResource

bundleNames, withBundles

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

clientProperties, clientProperty, usedNamespaces, withClientProperty

Method Detail

classBasedFoldingRules

java.util.List<ViewClassBasedFoldingRule> classBasedFoldingRules()

Returns the list of class-based folding rules assigned to this view.

The view result is folded according to these rules. If more than one rule applies, the rule with lowest index is used.

Returns:

the collection of class-based folding rules.

addClassBasedFoldingRules

ViewClassBasedFoldingRule addClassBasedFoldingRules()

Adds and assigns a new class-based folding rule to the view. The returned object should be customized according to the desired result structure.

Returns:

the new object, after is is added to the rules list.

withQueryName

RuleBasedViewDefinition withQueryName(java.lang.String queryName)

Changes the query name this view is based on.

A query with this name must exist in the UCMDB before the view can be saved or executed, unless a Query object is added in the execution itself. In that case, this queryName is ignored.

Parameters:

queryName - the new query name.

Returns:

this view definition.