public interface UtilityQueryInspector extends OsidCatalogQueryInspector
This is the query inspector for examining utility queries. Each method
specifies an AND
term while multiple terms from the same
method produce a nested OR.
Modifier and Type | Method and Description |
---|---|
IdTerm[] |
getAncestorUtilityIdTerms()
Gets the ancestor utility
Id terms. |
UtilityQueryInspector[] |
getAncestorUtilityTerms()
Gets the ancestor utility terms.
|
IdTerm[] |
getDescendantUtilityIdTerms()
Gets the descendant utility
Id terms. |
UtilityQueryInspector[] |
getDescendantUtilityTerms()
Gets the descendant utility terms.
|
IdTerm[] |
getMeterIdTerms()
Gets the meter
Id terms. |
MeterQueryInspector[] |
getMeterTerms()
Gets the meter terms.
|
UtilityQueryInspectorRecord |
getUtilityQueryInspectorRecord(Type utilityRecordType)
Gets the utility query record interface corresponding to the given
Utility record Type. |
getCommentIdTerms, getCommentTerms, getCreditIdTerms, getCreditTerms, getDescriptionTerms, getDisplayNameTerms, getGenusTypeTerms, getJournalEntryIdTerms, getJournalEntryTerms, getParentGenusTypeTerms, getRelationshipIdTerms, getRelationshipPeerIdTerms, getRelationshipTerms, getStateIdTerms, getStateTerms, getStatisticTerms, getSubjectIdTerms, getSubjectRelevancyTerms, getSubjectTerms
getIdTerms
getRecordTypeTerms
getRecordTypes, hasRecordType
getAnyTerms, getKeywordTerms
getBrandingIdTerms, getBrandingTerms, getLicenseTerms, getProviderIdTerms, getProviderTerms
IdTerm[] getMeterIdTerms()
Id
terms. Id
termsmandatory
- This method must be implemented. MeterQueryInspector[] getMeterTerms()
mandatory
- This method must be implemented. IdTerm[] getAncestorUtilityIdTerms()
Id
terms. Id
termsmandatory
- This method must be implemented. UtilityQueryInspector[] getAncestorUtilityTerms()
mandatory
- This method must be implemented. IdTerm[] getDescendantUtilityIdTerms()
Id
terms. Id
termsmandatory
- This method must be implemented. UtilityQueryInspector[] getDescendantUtilityTerms()
mandatory
- This method must be implemented. UtilityQueryInspectorRecord getUtilityQueryInspectorRecord(Type utilityRecordType) throws OperationFailedException
Utility
record Type.
Multiple retrievals
produce a nested OR
term.utilityRecordType
- a utility record typeNullArgumentException
- utilityRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(utilityRecordType)
is false
mandatory
- This method must be implemented.