Package com.hp.ucmdb.api.topology

This package contains services for defining and running TQL queries and processing the results.

See: Description

Interface Summary

Interface	Description
AttributeSortingRule	A rule for sorting by attribute name in either ascending or descending order.
ChangeStatistics
CIsChunk	The result of a retrieveCIsSortedChunk execution.
CisFromCachedQueryResults	Data structure for holding the result of an invocation of retrieveCiIdsFromCachedQueryResults
CompletePropertyCondition	A condition on a property with respect to a fixed value.
ConditionExpression<T,O>	A root of an expression tree structure.
ConditionExpressionBuilder<T,O>	Services to build complex expressions.
ConditionExpressionVisitor<T,O>	A visitor interface for expressions.
ContactNodeRestrictions<E>	Allows the restriction of contact nodes (see PerspectiveContactable.setAsPerspectiveContact() of the extending element.
CreateOutput
CreateStatus	Interface defines the result of of a TopologyUpdateService.createGracefully(TopologyModificationData, CreateGracefullyMode) operation.
DataStoresConditionable<E>	Allows the restriction of the extending element to one of: A specific set of data stores (DataStoresConditionable.withDataStores(java.lang.String...)). All data stores (DataStoresConditionable.withAllDataStores()). UCMDB Internal data store only (DataStoresConditionable.withInternalDataStoreOnly()).
DeleteOutput
DeleteStatus	Interface defines the result of of a TopologyUpdateService.deleteGracefully(TopologyModificationData) operation.
DependsOnQuery
DirectLink	Represent a query about a relation directly connecting two CIs, or a CI to itself.
ElementIdsForChangedCachedQueries	The result of TopologyQueryService.retrieveElementIdsForChangedCachedQueries(com.hp.ucmdb.api.topology.QueryNamesAndVersions, com.hp.ucmdb.api.topology.ElementIdsForChangedCachedQueriesOptions).
ElementIdsForChangedCachedQueriesOptions	Option object for TopologyQueryService.retrieveElementIdsForChangedCachedQueries(com.hp.ucmdb.api.topology.QueryNamesAndVersions, com.hp.ucmdb.api.topology.ElementIdsForChangedCachedQueriesOptions).
ElementIdsForChangedCachedQuery	An object representing a single change in a query result.
ExecutableQuery	Represents a server-side query suitable for execution.
ExecuteOutput
FolderResourcesGetResult
GracefulTopologyModificationOutput	Specifies the result of the graceful topology update
Graph
IdConditionable<E,T extends Element>	Indicates that the extending element may have an IDs condition.
IdentificationQueryDefinition
IncompleteLinkOnPropertyP1	This incomplete link on property can be completed using one of the "is..." methods.
IncompleteLinkOnPropertyP2
IncompletePropertyCondition	A factory-like interface that serves as a starting point for forming a proper condition on a property.
IndirectLinkDescriptor	A request descriptor for the "get the underlying paths" method.
InterQueryElementRestriction
InterQueryRestrictableElement<Element>
LinkConditionBuilder	The first part of the query link conditions.
LinkConditionElement
ListPropertiesUpdate
ListPropertyUpdate<Type>
LiveQuery	Live query is a query whose result is always kept updated.
LiveQueryResult
LiveTopology	Topology with version that allows to track changes in the query result
MergeInput	Created by IntelliJ IDEA.
MergeOutput	Created by IntelliJ IDEA.
ModelChangeVersion	Represents a version of a model changes.
MultipleReferencesWithFunctionDefinition	This definition applies a function over a collection of base queries and uses the resulting QueryDefinition.
NonCachedQueryResultConsumingType	Defines how a non-cached query is maintained.
OnPropertiesLink	Represent a query about relations between properties on CIs returned by the from node to properties present on the to node.
OnPropertiesLinkCondition
PartiallyCachedQueryResultConsumingType	Defines how a partially-cached query is maintained.
PerspectiveContactable<E>	Query elements with this interface may be set as perspectives "contact" elements using the PerspectiveContactable.setAsPerspectiveContact() method.
PropertiesCarrier<E>	Indicates that the extending element can be defined to bring properties to the result topology.
PropertiesCarrierWrapper	A syntactic wrapper, needed for Java type-safety.
PropertiesConditionable<E>	Indicates that the extending element can have a properties condition.
PropertiesToQuery	Defines a set of properties to retrieve as part of the query results.
PropertyConditionBuilder
QualifierConditionable<E>	Indicates that the extending element may have a qualifier condition.
QueriesExecutionBulk	Defines a bulk of queries and related resources for execution.
Query	Represents a query stored on the UCMDB server or a query to be saved in a specific folder path.
QueryChangeCommand	A command controlling changes to a query without knowledge of the query internal structure, type or dependencies.
QueryChangeResult	The result of a call to QueryManagementService.modifyQuery(QueryChangeCommand).
QueryDefinition	Definition of a UCMDB TQL query.
QueryFolder	Represents a folder in the queries folder structure.
QueryLink<QL extends QueryLink<QL>>	A link in the query definition.
QueryManagementService
QueryNamesAndVersions	Request object for TopologyQueryService.retrieveElementIdsForChangedCachedQueries(com.hp.ucmdb.api.topology.QueryNamesAndVersions, com.hp.ucmdb.api.topology.ElementIdsForChangedCachedQueriesOptions).
QueryNode	A node in the query definition.
QueryNodeOrigin	Services to access to the original query name and original node name.
QueryNodeRestrictions	Represents conditions on a node to further restrict a query defined in the UCMDB.
QueryReferenceDefinition<T extends QueryReferenceDefinition>	Parent interface for reference definitions.
QueryResultConsumingType	Defines how a query is maintained and stored in cache
QueryResultVersion	Represents a version of a query result.
QueryTreeVisitor	Implementations of this interace can be used to traverse the queries tree.
QueryValidationBulk	Defines a bulk of queries and related resources for validation
QueryVersion	Represents a version of a query.
SingleQueryReferenceDefinition	A single query reference definition holds a single base query name and, possibly, parameters and restrictions that should be used on that query.
SingleTopologyModification	Specifies the bulk of data along with the action to be taken upon the data
SupportsInvisibility<E>	Indicates that the extending element may be invisible.
Topology	Result of a topology query execution.
TopologyChangeOutput
TopologyCount	Result count of a topology query execution.
TopologyCountByClasses	Result count of a topology query execution.
TopologyData	A structure serving as input to topology modification methods.
TopologyModification	A structure serving as input to topology modification methods.
TopologyModificationBulk	Specifies a bulk of topology modifications
TopologyModificationBulkElement	Specifies an element of a bulk of topology modifications
TopologyModificationData
TopologyModificationFailure	Interface describes a topology modification failure.
TopologyModificationInput<T extends TopologyModificationInput<?>>	Specifies input for topology modification which can represent either a single modification or a modification bulk executed within transaction
TopologyQueryFactory	Services for creating queries.
TopologyQueryService	Interface for querying the UCMDB topology.
TopologyUpdateFactory	Factory for creating arguments for TopologyUpdateService methods.
TopologyUpdateService	Interface for updating topology: creating, updating, and deleting CIs and relations.
TypeConditionable<E>	Indicates that the extending element may have a type condition.
UpdateOutput

Enum Summary

Enum	Description
AttributeSortingOrderElementDirection
CreateGracefullyMode	The creation mode determines the behavior of the UCMDB with respect to existing CIs and relations.
CreateMode	The creation mode determines the behavior of the UCMDB with respect to existing CIs and relations.
DeleteMode	The deletion mode determines the behavior of the UCMDB with respect to CIs and relations that do not exist.
LinkConditionOperand
ModifyMode	The modification mode determines the behavior of the UCMDB with respect to CI and relations modification failures.
OnPropertiesLinkOp	Specifies the allowed operations in an OnPropertiesLink instance.
Operator
PropertiesCarrierBehavior
PropertiesConditionOperand
QualifierMatchingStrategy
QueriesFunction
QueryDefinitionFirstLoadStrategy	When a saved query is first loaded and calculated.
QueryDefinitionRecalcPriority	How soon a saved query is recalculated after data change.
QueryLinkType
QueryResultStoringType	Defines the storing type of the Query
QueryType	The available query types.
SelfLinkFilter
TopologyModificationAction	Specifies the action to be taken upon a topology modification data

Exception Summary

Exception	Description
FullSyncRequiredException	Cannot get changes due to size or other reason.
InvalidQueryDefinitionException	The query cannot be processed due to syntax or other error in the query.
TopologyUpdateException
TopologyUpdateMissingDataException

Package com.hp.ucmdb.api.topology Description

This package contains services for defining and running TQL queries and processing the results.