|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
@NotFinalAPI public interface SingleQueryReferenceDefinition
A single query reference definition holds a single base query name and, possibly, parameters and restrictions that should be used on that query.
There are two ways to define changes over a query:queryParameters()
can then be used to
insert values into those conditions, or even replace a named condition completely.restrictions()
map allows defining restrictions per node name.
A QueryNodeRestrictions object can be used to restrict a node to certain Ids, types or add additional property
conditions.Query
object with this definition returns the "flatten" QueryDefinition
- with all restrictions
and parameters already applied.
Note: While it is possible to define a query reference that does not add restrictions or parameters, it is useless
to do so.
Methods from the following interfaces refer to restrictions on the entire query:
Method Summary | |
---|---|
java.lang.String |
baseQueryName()
The query this definition is referencing. |
QueryNodeRestrictions |
nodeRestrictions(java.lang.String nodeName)
Creates or returns the node restrictions for the given node name. |
com.hp.ucmdb.api.topology.queryparameter.QueryParameters |
queryParameters()
The query parameters this definition should use. |
java.util.Map<java.lang.String,QueryNodeRestrictions> |
restrictions()
The map of restrictions. |
Methods inherited from interface com.hp.ucmdb.api.topology.QueryReferenceDefinition |
---|
asMultipleReferencesWithFunctionDefinition, asSingleQueryReferenceDefinition, description, firstLoadStrategy, name, recalcPriority, referenceDefinitionType, toExecutable, withDescription, withFirstLoadStrategy, withRecalcPriority |
Methods inherited from interface com.hp.ucmdb.api.bundles.BundledResource |
---|
bundleNames, withBundles |
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 |
---|
java.lang.String baseQueryName()
com.hp.ucmdb.api.topology.queryparameter.QueryParameters queryParameters()
java.util.Map<java.lang.String,QueryNodeRestrictions> restrictions()
QueryNodeRestrictions nodeRestrictions(java.lang.String nodeName)
nodeName
- the node name. A node with that name should exist in the base query.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |