com.hp.ucmdb.api.view

Interface ViewWithFoldingDefinition

All Superinterfaces:

BundledResource<ViewDefinition>, SupportsClientProperties<ViewDefinition>, ViewDefinition<ViewWithFoldingDefinition>

@NotFinalAPI
public interface ViewWithFoldingDefinition
extends ViewDefinition<ViewWithFoldingDefinition>

A view based on a query name and a folding definition.

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

Since:

UCMDB 9.0

Method Summary

Modifier and Type	Method and Description
FoldingDefinition	foldingDefinition() The folding definition of the view.
String	queryName() The name of the query this view is based on.
ViewWithFoldingDefinition	withQueryName(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, cmViewDefinition, description, name, toView, viewType, withCmViewDefinition, 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

queryName

String queryName()

The name of the query this view is based on.

Specified by:

queryName in interface ViewDefinition<ViewWithFoldingDefinition>

Returns:

the name of the query this view is based on.

withQueryName

ViewWithFoldingDefinition withQueryName(String queryName)

Changes the query name this view is based on.

A query with this name must exists before the view can be saved or executed, unless a Query object is added in the execution itself. If a Query object is added, the specified queryName is ignored.

Parameters:

queryName - the new query name.

Returns:

this view definition.

foldingDefinition

FoldingDefinition foldingDefinition()

The folding definition of the view.

Returns:

the folding definition of the view. Cannot be null.