Interface MeterQueryInspector
- All Superinterfaces:
Extensible, OsidBrowsableQueryInspector, OsidExtensibleQueryInspector, OsidIdentifiableQueryInspector, OsidObjectQueryInspector, OsidQueryInspector
This is the query inspector for examining meter queries. Each method
specifies an AND term while multiple terms from the same method
produce a nested OR .
-
Method Summary
Modifier and TypeMethodDescriptiongetMeterQueryInspectorRecord(Type meterRecordType) Gets the meter query inspector record corresponding to the givenMeterrecordType.IdTerm[]Gets the utilityIdterms.Gets the utility terms.Methods inherited from interface Extensible
getRecordTypes, hasRecordTypeModifier and TypeMethodDescriptionGets the record types available in this object.booleanhasRecordType(Type recordType) Tests if this object supports the given recordType.Methods inherited from interface OsidExtensibleQueryInspector
getRecordTypeTermsMethods inherited from interface OsidIdentifiableQueryInspector
getIdTermsMethods inherited from interface OsidObjectQueryInspector
getCommentIdTerms, getCommentTerms, getCreditIdTerms, getCreditTerms, getDescriptionTerms, getDisplayNameTerms, getGenusTypeTerms, getJournalEntryIdTerms, getJournalEntryTerms, getParentGenusTypeTerms, getRelationshipIdTerms, getRelationshipPeerIdTerms, getRelationshipTerms, getStateIdTerms, getStateTerms, getStatisticTerms, getSubjectIdTerms, getSubjectRelevancyTerms, getSubjectTermsModifier and TypeMethodDescriptionIdTerm[]Gets the commentIdquery terms.Gets the comment query terms.IdTerm[]Gets the creditIdquery terms.Gets the credit query terms.Gets the description query terms.Gets the display name query terms.TypeTerm[]Gets the genus type query terms.IdTerm[]Gets the journal entryIdquery terms.Gets the journal entry query terms.TypeTerm[]Gets the parent genus type query terms.IdTerm[]Gets the relationshipIdquery terms.IdTerm[]Gets the relationship peerIdquery terms.Gets the relationship query terms.IdTerm[]Gets the stateIdquery terms.Gets the state query terms.Gets the statistic query terms.IdTerm[]Gets the subjectIdquery terms.Gets the subject relevancy query terms.Gets the subject query terms.Methods inherited from interface OsidQueryInspector
getAnyTerms, getKeywordTermsModifier and TypeMethodDescriptionGets the any query terms.Gets the keyword query terms.
-
Method Details
-
getUtilityIdTerms
IdTerm[] getUtilityIdTerms()Gets the utilityIdterms.- Returns:
- the utility
Idterms - Compliance:
mandatory- This method must be implemented.
-
getUtilityTerms
UtilityQueryInspector[] getUtilityTerms()Gets the utility terms.- Returns:
- the utility terms
- Compliance:
mandatory- This method must be implemented.
-
getMeterQueryInspectorRecord
MeterQueryInspectorRecord getMeterQueryInspectorRecord(Type meterRecordType) throws OperationFailedException Gets the meter query inspector record corresponding to the givenMeterrecordType. Multiple retrievals produce a nestedORterm.- Parameters:
meterRecordType- a meter record type- Returns:
- the meter query inspector record
- Throws:
NullArgumentException-meterRecordTypeisnullOperationFailedException- unable to complete requestUnsupportedException-hasRecordType(meterRecordType)isfalse- Compliance:
mandatory- This method must be implemented.
-