com.hp.ucmdb.api.topology
Interface ExecutableQuery

All Superinterfaces:

ContactNodeRestrictions<ExecutableQuery>, DataStoresConditionable<ExecutableQuery>, PropertiesCarrier<ExecutableQuery>

public interface ExecutableQuery
extends PropertiesCarrier<ExecutableQuery>, DataStoresConditionable<ExecutableQuery>, ContactNodeRestrictions<ExecutableQuery>

Represents a server-side query suitable for execution. Enables modifying the execution environment. For example, enables changing the set of objects the query runs on, specifying parameters, additional restrictions and so on.

Changes made on this interface are never saved to the UCMDB and exist only in the execution context.

Methods from the PropertiesCarrier interface: Using any of the PropertiesCarrier methods on this object cancels all PropertiesCarrier definitions made on the original query definition.

Methods from the DataStoresConditionable interface: Using any of the DataStoresConditionable methods on this object cancels all DataStoresConditionable definitions made on the original query definition.

Methods from the ContactNodeRestrictions interface: Using any of the C ontactNodeRestrictions methods on this object cancels all ContactNodeRestrictions definitions made on the original query reference definition.

Since:

8.0

Method Summary

java.lang.String	getDataIntegrityRulesBundle()
PropertiesToQuery	nodePropertiesToQuery(java.lang.String nodeName) Deprecated. use propertiesToQueryPerNode
QueryNodeRestrictions	nodeRestrictions(java.lang.String nodeName) Returns the existing restrictions the specifed node so they can be added to and modified.
ExecutableQuery	onTopOfQuery(java.lang.String parentQueryName) Sets this query to run over the result of another query.
java.util.Map<java.lang.String,PropertiesCarrierWrapper>	propertiesToQueryPerNode() Returns the map of node name to properties.
PropertiesCarrierWrapper	propertiesToQueryPerNode(java.lang.String nodeName) Returns new or existing properties on a node so they can be added to and modified.
com.hp.ucmdb.api.topology.queryparameter.QueryParameters	queryParameters() Returns the QueryParameters interface.
void	setBooleanParameter(java.lang.String parameterName, boolean parameterValue) Deprecated. use queryParameters.
void	setBytesParameter(java.lang.String parameterName, byte[] parameterValue) Deprecated. use queryParameters()
void	setDateParameter(java.lang.String parameterName, java.util.Date parameterValue) Deprecated. use queryParameters()
void	setDoubleParameter(java.lang.String parameterName, double parameterValue) Deprecated. use queryParameters()
void	setFloatParameter(java.lang.String parameterName, float parameterValue) Deprecated. use queryParameters.
ExecutableQuery	setForceAdhocCalculationFlag() Sets this executable query to be calculated without using the query results cache.
void	setIntListParameter(java.lang.String parameterName, int[] parameterValue) Deprecated. use queryParameters()
void	setIntListParameter(java.lang.String parameterName, java.lang.Iterable<java.lang.Integer> parameterValue) Deprecated. use queryParameters()
void	setIntParameter(java.lang.String parameterName, int parameterValue) Deprecated. use queryParameters()
void	setLongParameter(java.lang.String parameterName, long parameterValue) Deprecated. use queryParameters()
void	setMaxChunkSize(int maxChunkSize) Sets the limit for maximum elements returned per chunk in the query's result.
void	setParameter(java.lang.String parameterName, java.lang.Object parameterValue) Deprecated. use queryParameters.
void	setStringListParameter(java.lang.String parameterName, java.lang.Iterable<java.lang.String> parameterValue) Deprecated. use queryParameters()
void	setStringListParameter(java.lang.String parameterName, java.lang.String[] parameterValue) Deprecated. use queryParameters()
void	setStringParameter(java.lang.String parameterName, java.lang.String parameterValue) Deprecated. use queryParameters()
ExecutableQuery	withDataIntegrityRulesBundle(java.lang.String dataIntegrityRulesBundle)

Methods inherited from interface com.hp.ucmdb.api.topology.PropertiesCarrier

getDefaultPropertiesToQuery, getPropertiesToQueryPerType, propertiesToQuery, queryKeyProperties, queryProperties, queryPropertiesWithQualifier, queryProperty

Methods inherited from interface com.hp.ucmdb.api.topology.DataStoresConditionable

dataStores, isAllDataStores, isInternalDataStoreOnly, withAllDataStores, withDataStores, withDataStores, withInternalDataStoreOnly

Methods inherited from interface com.hp.ucmdb.api.topology.ContactNodeRestrictions

queriesRestrictingContactNodes, restrictAllContactNodesByQueries, restrictAllContactNodesByQueries

Method Detail

onTopOfQuery

ExecutableQuery onTopOfQuery(java.lang.String parentQueryName)

Sets this query to run over the result of another query. The scope of the query is not the whole universe but over the subset defined by the result of another query.

Unlike QueryDefinition.withBaseQueryName(java.lang.String), the parent query result does not have to be calculated before this can be executed.

Parameters:

parentQueryName - the name of the query that specifies the "universe" for this query to run on

Returns:

this object

See Also:

QueryDefinition.withBaseQueryName(java.lang.String)

nodeRestrictions

QueryNodeRestrictions nodeRestrictions(java.lang.String nodeName)

Returns the existing restrictions the specifed node so they can be added to and modified. If no restrictions object exists, a new one is created.

Parameters:

nodeName - The node of which to return restrictions.

Returns:

the restrictions of the specified node

nodePropertiesToQuery

@Deprecated
PropertiesToQuery nodePropertiesToQuery(java.lang.String nodeName)

Deprecated. use propertiesToQueryPerNode

propertiesToQueryPerNode

PropertiesCarrierWrapper propertiesToQueryPerNode(java.lang.String nodeName)

Returns new or existing properties on a node so they can be added to and modified.

Returns:

the properties of the node query

propertiesToQueryPerNode

java.util.Map<java.lang.String,PropertiesCarrierWrapper> propertiesToQueryPerNode()

Returns the map of node name to properties.

Will not return null, but may return empty map if no there was no previous invocation of propertiesToQueryPerNode(String).

setMaxChunkSize

void setMaxChunkSize(int maxChunkSize)

Sets the limit for maximum elements returned per chunk in the query's result. If the query's result is larger than this limit, the Topology returned must be asked quried to see if there are more chunks. If so, retrieve these chunks with Topology.getNextChunk().

setForceAdhocCalculationFlag

ExecutableQuery setForceAdhocCalculationFlag()

Sets this executable query to be calculated without using the query results cache.

This trades processing time (for all of the uCMDB clients) for up-to-date results in saved queries. Non-active queries and non-saved queries are executed ad-hoc anyway.

Note: some configurations mandates this anyway.

queryParameters

@NotFinalAPI
com.hp.ucmdb.api.topology.queryparameter.QueryParameters queryParameters()

Returns the QueryParameters interface. The QueryParameters allows setting values to named conditions or even replacing the named conditions altogether.

Returns:

the QueryParameters associated with this ExecutableQuery.

withDataIntegrityRulesBundle

@NotFinalAPI
ExecutableQuery withDataIntegrityRulesBundle(java.lang.String dataIntegrityRulesBundle)

getDataIntegrityRulesBundle

@NotFinalAPI
java.lang.String getDataIntegrityRulesBundle()

setParameter

@Deprecated
void setParameter(java.lang.String parameterName,
                             java.lang.Object parameterValue)

Deprecated. use queryParameters.

setBooleanParameter

@Deprecated
void setBooleanParameter(java.lang.String parameterName,
                                    boolean parameterValue)

Deprecated. use queryParameters.

setBytesParameter

@Deprecated
void setBytesParameter(java.lang.String parameterName,
                                  byte[] parameterValue)

Deprecated. use queryParameters()

setDateParameter

@Deprecated
void setDateParameter(java.lang.String parameterName,
                                 java.util.Date parameterValue)

Deprecated. use queryParameters()

setDoubleParameter

@Deprecated
void setDoubleParameter(java.lang.String parameterName,
                                   double parameterValue)

Deprecated. use queryParameters()

setFloatParameter

@Deprecated
void setFloatParameter(java.lang.String parameterName,
                                  float parameterValue)

Deprecated. use queryParameters.

setIntListParameter

@Deprecated
void setIntListParameter(java.lang.String parameterName,
                                    int[] parameterValue)

Deprecated. use queryParameters()

setIntListParameter

@Deprecated
void setIntListParameter(java.lang.String parameterName,
                                    java.lang.Iterable<java.lang.Integer> parameterValue)

Deprecated. use queryParameters()

setIntParameter

@Deprecated
void setIntParameter(java.lang.String parameterName,
                                int parameterValue)

Deprecated. use queryParameters()

setLongParameter

@Deprecated
void setLongParameter(java.lang.String parameterName,
                                 long parameterValue)

Deprecated. use queryParameters()

setStringListParameter

@Deprecated
void setStringListParameter(java.lang.String parameterName,
                                       java.lang.String[] parameterValue)

Deprecated. use queryParameters()

setStringListParameter

@Deprecated
void setStringListParameter(java.lang.String parameterName,
                                       java.lang.Iterable<java.lang.String> parameterValue)

Deprecated. use queryParameters()

setStringParameter

@Deprecated
void setStringParameter(java.lang.String parameterName,
                                   java.lang.String parameterValue)

Deprecated. use queryParameters()