Package com.hp.ucmdb.api.view
Interface View
Represents a view defined on the uCMDB server or a new view to be executed or saved on the uCMDB server.
A view is a hierarchical presentation of a query result (Topology). This presentation omits all Relations and orders
the CIs in a tree-like structure, which might or might not be a spanning tree over the topology. This structure may
be defined in various ways - direct definition (using
ViewWithFoldingDefinition), definition by reference
(using SingleViewReferenceDefinition) or definition by multiple building blocks
(PerspectiveBasedViewReferenceDefinition).
The view may be executed using the ViewService to get a the hierarchical presentation as a
ViewResult object.
Note: If the view was created using ViewFactory.createView(String), the first call to
either viewDefinition or viewVersion will result in a server call to fetch the view information.- Since:
- 8.0
-
Method Summary
Modifier and TypeMethodDescriptionDeprecated.use viewDefinition().description();Deprecated.use viewDefinition().asViewWithFoldingDefinition().foldingDefinition().Deprecated.use viewDefinition().description();getName()Deprecated.use name();Deprecated.use viewDefinition().asViewWithFoldingDefinition().queryName().name()Returns the name of the view.Deprecated.use viewDefinition().asViewWithFoldingDefinition().queryName().Returns a client-side representation of the definition of the view on the server.Returns the version of this view as it was saved on the server.
-
Method Details
-
name
String name()Returns the name of the view. -
viewDefinition
Returns a client-side representation of the definition of the view on the server. The returned object is used to run a view. Modifying the returned object does not change the query definition stored in the UCMDB.- Returns:
- the view definition as it was saved on the server.
- Throws:
ViewDoesNotExistException- if the View object was created usingViewFactory.createView(String)and a view by the given name does exist on the server.
-
viewVersion
Returns the version of this view as it was saved on the server. Versions are updated on save. Views or View object created from view definition (ViewDefinition.toView()) but not saved have a default version that is lower than all other versions. -
foldingDefinition
Deprecated.use viewDefinition().asViewWithFoldingDefinition().foldingDefinition(). Check view type!- Throws:
ViewDoesNotExistException
-
getDescription
Deprecated.use viewDefinition().description(); -
description
Deprecated.use viewDefinition().description();- Throws:
ViewDoesNotExistException
-
getQueryName
Deprecated.use viewDefinition().asViewWithFoldingDefinition().queryName(). Check view type! -
queryName
Deprecated.use viewDefinition().asViewWithFoldingDefinition().queryName(). Check view type!- Throws:
ViewDoesNotExistException
-
getName
Deprecated.use name();
-