com.hp.ucmdb.api.view

Interface SingleViewReferenceDefinition

All Superinterfaces:

BundledResource<ViewDefinition>, SupportsClientProperties<ViewDefinition>, ViewDefinition<SingleViewReferenceDefinition>

@NotFinalAPI
public interface SingleViewReferenceDefinition
extends ViewDefinition<SingleViewReferenceDefinition>

A reference definition that uses the folding definition from the view identified by base view name, but defines another query to be used. The query referenced by this definition and the query referenced by the base view definition must have the same internal names.

The intended usage for this definition is:

        (View)                              (Query)
       Base View ---- with query name --> Base Query
          ^                                    ^
          |                                    |
       baseViewName()                     baseQueryName()
          |                                    |
       View Reference --- queryName() --> Query Reference with parameters / restrictions
  (SingleViewReferenceDefinition)         (SingleQueryReferenceDefinition)
 

This structure allows "view templating" - using a predefined folding definition with a parameterized query / restrictions on the base query.

Unless a query is given at execution time, the query identified by the queryName must exist in the sevrver before executing the view.

A ViewWithFoldingDefinition view identified by the base view name must exist in the UCMDB server before executing this view.

Since:

UCMDB 9.0

Method Summary

Modifier and Type	Method and Description
String	baseViewName() The view from which the folding definition is used.
String	queryName() The name of the query 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<SingleViewReferenceDefinition>

Returns:

The query this view is based on.

baseViewName

String baseViewName()

The view from which the folding definition is used.

Returns:

The view from which the folding definition is used.