com.hp.ucmdb.api.topology

Interface TopologyQueryFactory

public interface TopologyQueryFactory

Services for creating queries.

Method Summary

Modifier and Type	Method and Description
AttributeSortingRule	createAttributeSortingOrderElement(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<com.hp.ucmdb.api.topology.IndirectLinkDescriptor>).
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(String name, QueriesFunction queriesFunction, Collection<String> baseQueriesNames) Creates a new reference to a function over multiple queries.
Query	createNamedQuery(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.
Query	createQuery(QueryDefinition queryDefinition) Creates an abstraction object over a query definition to be saved in a specific folder path.
Query	createQuery(QueryReferenceDefinition queryReferenceDefinition) Creates an abstraction object over a query reference definition to be saved in a specific folder path.
QueryChangeCommand	createQueryChangeCommand(String queryName) Creates a new command for query modification.
QueryDefinition	createQueryDefinition(String queryName) Creates a new query definition having the specified name.
QueryDefinition	createQueryDefinition(String queryName, QueryDefinition queryDefinition) Creates a new query definition having the specified name by cloning an existing query definition.
QueriesExecutionBulk	createQueryExecutionBulk() Crates a query execution bulk for TopologyQueryService.executeQueriesTree(com.hp.ucmdb.api.topology.QueriesExecutionBulk).
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(String versionAsString) Creates a query result vresion from the string produced by QueryResultVersion.asString() for comparison purposes.
QueryValidationBulk	createQueryValidationBulk()
QueryVersion	createQueryVersion(String versionAsString) Creates a query result vresion from the string produced by QueryVersion.asString() for comparison purposes.
SingleQueryReferenceDefinition	createSingleQueryReferenceDefinition(String name, String baseQueryName) Creates a new reference to a single query.
void	fillQueriesExecutionBulkWithPerspectiveApplication(QueriesExecutionBulk bulk, String topLevelName, List<Set<String>> perspectiveHierarchy, String seedQueryName) Fills the given QueriesExecutionBulk with queries that would have been created if a "perspective application" would have been saved.

Method Detail

createQueryDefinition

QueryDefinition createQueryDefinition(String queryName)

Creates a new query definition having the specified name.

createQueryDefinition

@NotFinalAPI
QueryDefinition createQueryDefinition(String queryName,
                                                   QueryDefinition queryDefinition)

Creates a new query definition having the specified name by cloning an existing query definition.

createSingleQueryReferenceDefinition

@NotFinalAPI
SingleQueryReferenceDefinition createSingleQueryReferenceDefinition(String name,
                                                                                 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(String name,
                                                                                                     QueriesFunction queriesFunction,
                                                                                                     Collection<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(String queryName)

Creates an abstraction object over a query stored in UCMDB.

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

createQuery

Query createQuery(QueryDefinition queryDefinition)

Creates an abstraction object over a query definition to be saved in a specific folder path.

Parameters:

queryDefinition -

Returns:

createQuery

Query createQuery(QueryReferenceDefinition queryReferenceDefinition)

Creates an abstraction object over a query reference definition to be saved in a specific folder path.

Parameters:

queryReferenceDefinition -

Returns:

createQueryResultVersion

QueryResultVersion createQueryResultVersion(String versionAsString)

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

createQueryVersion

QueryVersion createQueryVersion(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(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<com.hp.ucmdb.api.topology.IndirectLinkDescriptor>). See that method for description.

Returns:

the request descriptor.

createQueryChangeCommand

@NotFinalAPI
QueryChangeCommand createQueryChangeCommand(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.

createQueryExecutionBulk

@NotFinalAPI
QueriesExecutionBulk createQueryExecutionBulk()

Crates a query execution bulk for TopologyQueryService.executeQueriesTree(com.hp.ucmdb.api.topology.QueriesExecutionBulk). See that method for full description.

Returns:

the bulk object.

fillQueriesExecutionBulkWithPerspectiveApplication

void fillQueriesExecutionBulkWithPerspectiveApplication(QueriesExecutionBulk bulk,
                                                        String topLevelName,
                                                        List<Set<String>> perspectiveHierarchy,
                                                        String seedQueryName)

Fills the given QueriesExecutionBulk with queries that would have been created if a "perspective application" would have been saved. It is guaranteed that this method will add a query definition (or reference definition) with the name given as the "top level name". If the bulk contains queries with conflicting names and exception will occur. For full details about perspective application, please see QueryManagementService.savePerspectiveApplication(java.lang.String, java.util.List<java.util.Set<java.lang.String>>, java.lang.String, com.hp.ucmdb.api.topology.QueryDefinitionRecalcPriority, com.hp.ucmdb.api.topology.QueryDefinitionFirstLoadStrategy).

Parameters:

bulk - the query execution bulk. This may be created by createQueryExecutionBulk().

topLevelName - the top level query name. This can be used as a reference by queries added to the bulk later.

perspectiveHierarchy - the perspective hierarchy.

seedQueryName - the seed query name. A query with this name must exist in the UCMDB or in the bulk.