com.hp.ucmdb.api.view

Interface ViewDefinition<T extends ViewDefinition>

All Superinterfaces:

BundledResource<ViewDefinition>, SupportsClientProperties<ViewDefinition>

All Known Subinterfaces:

PerspectiveBasedViewReferenceDefinition, RuleBasedViewDefinition, SingleViewReferenceDefinition, ViewWithFoldingDefinition

@NotFinalAPI
public interface ViewDefinition<T extends ViewDefinition>
extends BundledResource<ViewDefinition>, SupportsClientProperties<ViewDefinition>

Since:

UCMDB 9.0

Method Summary

Modifier and Type	Method and Description
PerspectiveBasedViewReferenceDefinition	asPerspectiveBasedViewReferenceDefinition() Returns this interface as a PerspectiveBasedViewReferenceDefinition.
RuleBasedViewDefinition	asRuleBasedViewDefinition() Returns this interface as a RuleBasedViewDefinition.
SingleViewReferenceDefinition	asSingleViewReference() Returns this interface as a SingleViewReference.
ViewWithFoldingDefinition	asViewWithFoldingDefinition() Returns this interface as a ViewWithFoldingDefinition.
CmViewDefinition	cmViewDefinition() Returns CM definitions for the view
String	description() Returns a human-readable description of the view purpose.
String	name() The name fo the view.
String	queryName() Returns the name of the query this view is based on.
View	toView() Return an object that can be executed using the ViewService methods.
ViewType	viewType() The type of the view.
T	withCmViewDefinition(CmViewDefinition cmViewDefinition)
T	withDescription(String description) Changes the human-readable description of the view.

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

name

String name()

The name fo the view.

Returns:

the name of the view.

description

String description()

Returns a human-readable description of the view purpose.

withDescription

T withDescription(String description)

Changes the human-readable description of the view.

Parameters:

description - the new description.

Returns:

this view.

toView

View toView()

Return an object that can be executed using the ViewService methods.

Returns:

an object that can be executed using the ViewService methods.

viewType

ViewType viewType()

The type of the view.

Returns:

the type of the view.

queryName

String queryName()

Returns the name of the query this view is based on.

To see what the query name actually means for the specific view definition, see the actual view definition (ViewWithFoldingDefinition, SingleViewReferenceDefinition or PerspectiveBasedViewReferenceDefinition, according to the viewType()).

Returns:

The name of the query this view is based on.

cmViewDefinition

CmViewDefinition cmViewDefinition()

Returns CM definitions for the view

Returns:

a CmViewDefinition object for the the view

withCmViewDefinition

T withCmViewDefinition(CmViewDefinition cmViewDefinition)

asViewWithFoldingDefinition

ViewWithFoldingDefinition asViewWithFoldingDefinition()
                                               throws ClassCastException

Returns this interface as a ViewWithFoldingDefinition.

Returns:

this interface, cast to ViewWithFoldingDefinition.

Throws:

ClassCastException - if viewType() is not ViewType.VIEW_WITH_FOLDING_DEFINITION.

asSingleViewReference

SingleViewReferenceDefinition asSingleViewReference()
                                             throws ClassCastException

Returns this interface as a SingleViewReference.

Returns:

this interface, cast to SingleViewReference.

Throws:

ClassCastException - if viewType() is not ViewType.SINGLE_VIEW_REFERENCE_DEFINITION.

asPerspectiveBasedViewReferenceDefinition

PerspectiveBasedViewReferenceDefinition asPerspectiveBasedViewReferenceDefinition()
                                                                           throws ClassCastException

Returns this interface as a PerspectiveBasedViewReferenceDefinition.

Returns:

this interface, cast to PerspectiveBasedViewReferenceDefinition.

Throws:

ClassCastException - if viewType() is not ViewType.PERSPECTIVES_BASED_VIEW_REFERENCE_DEFINITION.

asRuleBasedViewDefinition

RuleBasedViewDefinition asRuleBasedViewDefinition()
                                           throws ClassCastException

Returns this interface as a RuleBasedViewDefinition.

Returns:

this interface, cast to RuleBasedViewDefinition.

Throws:

ClassCastException - if viewType() is not ViewType.RULE_BASED_VIEW.