com.hp.ucmdb.api.topology
Interface TopologyQueryFactory

public interface TopologyQueryFactory

Services for creating queries.

Method Summary

AttributeSortingRule	createAttributeSortingOrderElement(java.lang.String attributeName, AttributeSortingOrderElementDirection direction) Creates and returns a sorting rule.
ElementIdsForChangedCachedQueriesOptions	createElementIdsForChangedCachedQueriesOptions() Creates an options object for TopologyQueryService.retrieveElementIdsForChangedCachedQueries(com.hp.ucmdb.api.topology.QueryNamesAndVersions, com.hp.ucmdb.api.topology.ElementIdsForChangedCachedQueriesOptions).
IndirectLinkDescriptor	createIndirectLinkDescriptor() Creates a request descriptor for TopologyQueryService.retrieveIndirectLinkPaths(com.hp.ucmdb.api.topology.ExecutableQuery, java.util.Set).
LinkConditionBuilder	createLinkConditionBuilder(QueryDefinition queryDefinition) Creates and returns a link condition builder, to be used for building complex link condition trees.
ModelEventsFilter	createModelEventsFilter() Creates a new filter for the model listener.
ModelListenerFilter	createModelListenerFilter() Deprecated. replaced by createModelEventsFilter()
MultipleReferencesWithFunctionDefinition	createMultipleReferencesWithFunctionDefinition(java.lang.String name, QueriesFunction queriesFunction, java.util.Collection<java.lang.String> baseQueriesNames) Creates a new reference to a function over multiple queries.
Query	createNamedQuery(java.lang.String queryName) Creates an abstraction object over a query stored in UCMDB.
PropertyConditionBuilder	createPropertyConditionBuilder() Creates and returns a property condition builder, to be used for building complex propery condition trees.
QueryChangeCommand	createQueryChangeCommand(java.lang.String queryName) Creates a new command for query modification.
QueryDefinition	createQueryDefinition(java.lang.String queryName) Creates a new query definition having the specified name.
QueryManagementListenerFilter	createQueryManagementListenerFilter() Creates a new filter for the query management listener.
QueryNamesAndVersions	createQueryNamesAndVersions() Creates a request object for TopologyQueryService.retrieveElementIdsForChangedCachedQueries(com.hp.ucmdb.api.topology.QueryNamesAndVersions, com.hp.ucmdb.api.topology.ElementIdsForChangedCachedQueriesOptions).
QueryResultVersion	createQueryResultVersion(java.lang.String versionAsString) Creates a query result vresion from the string produced by QueryResultVersion.asString() for comparison purposes.
QueryValidationBulk	createQueryValidationBulk()
QueryVersion	createQueryVersion(java.lang.String versionAsString) Creates a query result vresion from the string produced by QueryVersion.asString() for comparison purposes.
SingleQueryReferenceDefinition	createSingleQueryReferenceDefinition(java.lang.String name, java.lang.String baseQueryName) Creates a new reference to a single query.

Method Detail

createQueryDefinition

QueryDefinition createQueryDefinition(java.lang.String queryName)

Creates a new query definition having the specified name.

createSingleQueryReferenceDefinition

@NotFinalAPI
SingleQueryReferenceDefinition createSingleQueryReferenceDefinition(java.lang.String name,
                                                                                java.lang.String baseQueryName)

Creates a new reference to a single query. Later, restrictions and parameters can be added to that reference. See SingleQueryReferenceDefinition for full explanation.

Parameters:

name - the name of the definition.

baseQueryName - the query name this definition is based on.

Returns:

a SingleQueryReferenceDefinition object.

See Also:

SingleQueryReferenceDefinition

createMultipleReferencesWithFunctionDefinition

@NotFinalAPI
MultipleReferencesWithFunctionDefinition createMultipleReferencesWithFunctionDefinition(java.lang.String name,
                                                                                                    QueriesFunction queriesFunction,
                                                                                                    java.util.Collection<java.lang.String> baseQueriesNames)

Creates a new reference to a function over multiple queries. See MultipleReferencesWithFunctionDefinition for full explanation.

Parameters:

name - the name of the definition.

queriesFunction - the function to be used.

baseQueriesNames - the queries the function should be applied on.

Returns:

a MultipleReferencesWithFunctionDefinition object.

See Also:

MultipleReferencesWithFunctionDefinition

createNamedQuery

Query createNamedQuery(java.lang.String queryName)

Creates an abstraction object over a query stored in UCMDB.

For easier access, please see TopologyQueryService.createQueryStub(java.lang.String).

createQueryResultVersion

QueryResultVersion createQueryResultVersion(java.lang.String versionAsString)

Creates a query result vresion from the string produced by QueryResultVersion.asString() for comparison purposes.

createQueryVersion

QueryVersion createQueryVersion(java.lang.String versionAsString)

Creates a query result vresion from the string produced by QueryVersion.asString() for comparison purposes.

createPropertyConditionBuilder

PropertyConditionBuilder createPropertyConditionBuilder()

Creates and returns a property condition builder, to be used for building complex propery condition trees.

Use this builder to build conditions for query definition elements that support propery conditions. Conditions set on this builder directly have no effect.

createLinkConditionBuilder

LinkConditionBuilder createLinkConditionBuilder(QueryDefinition queryDefinition)

Creates and returns a link condition builder, to be used for building complex link condition trees.

createAttributeSortingOrderElement

@NotFinalAPI
AttributeSortingRule createAttributeSortingOrderElement(java.lang.String attributeName,
                                                                    AttributeSortingOrderElementDirection direction)

Creates and returns a sorting rule.

Parameters:

attributeName - the attribute name to sort by.

direction - the direction to sort.

Returns:

a sorting rule.

createModelEventsFilter

ModelEventsFilter createModelEventsFilter()

Creates a new filter for the model listener.

createModelListenerFilter

ModelListenerFilter createModelListenerFilter()

Deprecated. replaced by createModelEventsFilter()

Creates a new filter for the model listener.

createQueryManagementListenerFilter

QueryManagementListenerFilter createQueryManagementListenerFilter()

Creates a new filter for the query management listener.

Returns:

a new filter for query management listener

Since:

9.0

createIndirectLinkDescriptor

@NotFinalAPI
IndirectLinkDescriptor createIndirectLinkDescriptor()

Creates a request descriptor for TopologyQueryService.retrieveIndirectLinkPaths(com.hp.ucmdb.api.topology.ExecutableQuery, java.util.Set). See that method for description.

Returns:

the request descriptor.

createQueryChangeCommand

@NotFinalAPI
QueryChangeCommand createQueryChangeCommand(java.lang.String queryName)

Creates a new command for query modification.

See QueryManagementService#modifyQuery(QueryChangeCommand) for detailed explanation.

Parameters:

queryName - the query that should be changed.

Returns:

the command.

createQueryValidationBulk

@NotFinalAPI
QueryValidationBulk createQueryValidationBulk()

createQueryNamesAndVersions

@NotFinalAPI
QueryNamesAndVersions createQueryNamesAndVersions()

Creates a request object for TopologyQueryService.retrieveElementIdsForChangedCachedQueries(com.hp.ucmdb.api.topology.QueryNamesAndVersions, com.hp.ucmdb.api.topology.ElementIdsForChangedCachedQueriesOptions). See that method for full description.

Returns:

the request object.

createElementIdsForChangedCachedQueriesOptions

@NotFinalAPI
ElementIdsForChangedCachedQueriesOptions createElementIdsForChangedCachedQueriesOptions()

Creates an options object for TopologyQueryService.retrieveElementIdsForChangedCachedQueries(com.hp.ucmdb.api.topology.QueryNamesAndVersions, com.hp.ucmdb.api.topology.ElementIdsForChangedCachedQueriesOptions). See that method for full description.

Returns:

the request object.