|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
@NotFinalAPI public interface QueryReferenceDefinition<T extends QueryReferenceDefinition>
Parent interface for reference definitions.
Reference definitions rely on other queries which may be reference or "regular". References act recursively, but not in a cycle. If the original query changes, the reference definition is updated. The query or queries the reference definition relies on are called "base queries".referenceDefinitionType()
method.
Method Summary | |
---|---|
MultipleReferencesWithFunctionDefinition |
asMultipleReferencesWithFunctionDefinition()
Returns this interface as a MultipleReferencesWithFunctionDefinition . |
SingleQueryReferenceDefinition |
asSingleQueryReferenceDefinition()
Returns this interface as a SingleQueryReferenceDefinition. |
java.lang.String |
description()
A human-readable description of the query definition purpose. |
QueryDefinitionFirstLoadStrategy |
firstLoadStrategy()
The values that determines when a saved query should first be loaded and calculated. |
java.lang.String |
name()
The name of the query definition. |
QueryDefinitionRecalcPriority |
recalcPriority()
The value that determines how soon a saved query is recalculated after data change. |
QueryType |
referenceDefinitionType()
Returns the type of this reference definition. |
ExecutableQuery |
toExecutable()
Converts this query definition into an executable query object for passing to TopologyQueryService.executeQuery(ExecutableQuery) . |
T |
withDescription(java.lang.String description)
Sets a human-readable description of the query definition purpose. |
T |
withFirstLoadStrategy(QueryDefinitionFirstLoadStrategy firstLoadStrategy)
Sets when a saved query should first be loaded and calculated. |
T |
withRecalcPriority(QueryDefinitionRecalcPriority recalcPriority)
Sets how soon a saved query is recalculated after data change. |
Methods inherited from interface com.hp.ucmdb.api.bundles.BundledResource |
---|
bundleNames, withBundles |
Method Detail |
---|
java.lang.String name()
java.lang.String description()
T withDescription(java.lang.String description)
description
- the description.
QueryDefinitionRecalcPriority recalcPriority()
withRecalcPriority(QueryDefinitionRecalcPriority)
T withRecalcPriority(QueryDefinitionRecalcPriority recalcPriority)
QueryDefinitionFirstLoadStrategy firstLoadStrategy()
withFirstLoadStrategy(QueryDefinitionFirstLoadStrategy)
T withFirstLoadStrategy(QueryDefinitionFirstLoadStrategy firstLoadStrategy)
ExecutableQuery toExecutable()
TopologyQueryService.executeQuery(ExecutableQuery)
.
QueryType referenceDefinitionType()
SingleQueryReferenceDefinition asSingleQueryReferenceDefinition() throws java.lang.ClassCastException
referenceDefinitionType()
is not QueryType.SINGLE_REFERENCE
java.lang.ClassCastException
- if referenceDefinitionType()
is not QueryType.SINGLE_REFERENCE.MultipleReferencesWithFunctionDefinition asMultipleReferencesWithFunctionDefinition() throws java.lang.ClassCastException
referenceDefinitionType()
is not QueryType.MULTIPLE_REFERENCES_WITH_FUNCTION
java.lang.ClassCastException
- if referenceDefinitionType()
is not QueryType.MULTIPLE_REFERENCES_WITH_FUNCTION.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |