com.hp.ucmdb.api.topology
Interface QueryChangeCommand

@NotFinalAPI
public interface QueryChangeCommand

A command controlling changes to a query without knowledge of the query internal structure, type or dependencies.

All "setters" return 'this' to facilitate method chaining.

Can be created using TopologyQueryFactory.createQueryChangeCommand(String).

Since:

UCMDB 9.0

See Also:

QueryManagementService.modifyQuery(QueryChangeCommand)

Method Summary

QueryChangeCommand	attachToBundles(java.util.Collection<java.lang.String> bundles) Attaches bundles to the query, adding them to the query's existing bundles, if any.
QueryChangeCommand	attachToBundles(java.lang.String... bundles) Attaches bundles to the query, adding them to the query's existing bundles, if any.
java.util.Set<java.lang.String>	bundlesToAttachTo() Returns the bundles the command will attach to the query.
java.util.Set<java.lang.String>	bundlesToDetachFrom() Returns the bundles the command should detach from the query.
QueryChangeCommand	changeFirstLoadStrategyTo(QueryDefinitionFirstLoadStrategy firstLoadStrategy) Changes the first load strategy of the query to the given value.
QueryChangeCommand	changeRecalcPriorityTo(QueryDefinitionRecalcPriority recalcPriority) Changes the recalculation priority of the query to the given value.
QueryChangeCommand	detachFromBundles(java.util.Collection<java.lang.String> bundles) Detachs the bundles from the query.
QueryChangeCommand	detachFromBundles(java.lang.String... bundles) Detachs the bundles from the query.
QueryDefinitionFirstLoadStrategy	firstLoadStrategyToChangeTo() Returns the previously set first load strategy, or null if none was set.
java.lang.String	queryName() The name of the query the command affects.
QueryDefinitionRecalcPriority	recalcPriorityToChangeTo() Returns the previously set recalculation prioirty, or null if none was set.
QueryChangeCommand	setInternalDataStoreOnly() Changes all the data store settings for all elements in the query definition to "internal".
boolean	shouldSetInternalDataStoreOnly() Returns true if setInternalDataStoreOnly() was called.

Method Detail

queryName

java.lang.String queryName()

The name of the query the command affects.

Returns:

the query name the command affects.

changeRecalcPriorityTo

QueryChangeCommand changeRecalcPriorityTo(QueryDefinitionRecalcPriority recalcPriority)

Changes the recalculation priority of the query to the given value.

recalcPriorityToChangeTo

QueryDefinitionRecalcPriority recalcPriorityToChangeTo()

Returns the previously set recalculation prioirty, or null if none was set.

changeFirstLoadStrategyTo

QueryChangeCommand changeFirstLoadStrategyTo(QueryDefinitionFirstLoadStrategy firstLoadStrategy)

Changes the first load strategy of the query to the given value.

firstLoadStrategyToChangeTo

QueryDefinitionFirstLoadStrategy firstLoadStrategyToChangeTo()

Returns the previously set first load strategy, or null if none was set.

setInternalDataStoreOnly

QueryChangeCommand setInternalDataStoreOnly()

Changes all the data store settings for all elements in the query definition to "internal". This allows the query to run restricted to the CMDB data.

shouldSetInternalDataStoreOnly

boolean shouldSetInternalDataStoreOnly()

Returns true if setInternalDataStoreOnly() was called.

attachToBundles

QueryChangeCommand attachToBundles(java.util.Collection<java.lang.String> bundles)

Attaches bundles to the query, adding them to the query's existing bundles, if any.

If a detach and attach operation are both called on the same bundle, the later call determines the behavior.

attachToBundles

QueryChangeCommand attachToBundles(java.lang.String... bundles)

Attaches bundles to the query, adding them to the query's existing bundles, if any.

If a detach and attach operation are both called on the same bundle, the later call determines the behavior.

bundlesToAttachTo

java.util.Set<java.lang.String> bundlesToAttachTo()

Returns the bundles the command will attach to the query. These bundles are added to the query's bundles, if any.

If a detach and attach operation are both called on the same bundle, the later call determines the behavior.

detachFromBundles

QueryChangeCommand detachFromBundles(java.util.Collection<java.lang.String> bundles)

Detachs the bundles from the query.

If a detach and attach operation are both called on the same bundle, the later call determines the behavior.

detachFromBundles

QueryChangeCommand detachFromBundles(java.lang.String... bundles)

Detachs the bundles from the query.

If a detach and attach operation are both called on the same bundle, the later call determines the behavior.

bundlesToDetachFrom

java.util.Set<java.lang.String> bundlesToDetachFrom()

Returns the bundles the command should detach from the query.

If a detach and attach operation are both called on the same bundle, the later call determines the behavior.