org.osid.metering

Interface UtilityQueryInspector

All Superinterfaces:

Extensible, OsidBrowsableQueryInspector, OsidCatalogQueryInspector, OsidExtensibleQueryInspector, OsidFederateableQueryInspector, OsidIdentifiableQueryInspector, OsidObjectQueryInspector, OsidQueryInspector, OsidSourceableQueryInspector

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.

Method Summary

Methods

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.

Methods inherited from interface org.osid.OsidObjectQueryInspector

getCommentIdTerms, getCommentTerms, getCreditIdTerms, getCreditTerms, getDescriptionTerms, getDisplayNameTerms, getGenusTypeTerms, getJournalEntryIdTerms, getJournalEntryTerms, getParentGenusTypeTerms, getRelationshipIdTerms, getRelationshipPeerIdTerms, getRelationshipTerms, getStateIdTerms, getStateTerms, getStatisticTerms, getSubjectIdTerms, getSubjectRelevancyTerms, getSubjectTerms

Methods inherited from interface org.osid.OsidIdentifiableQueryInspector

getIdTerms

Methods inherited from interface org.osid.OsidExtensibleQueryInspector

getRecordTypeTerms

Methods inherited from interface org.osid.Extensible

getRecordTypes, hasRecordType

Methods inherited from interface org.osid.OsidQueryInspector

getAnyTerms, getKeywordTerms

Methods inherited from interface org.osid.OsidSourceableQueryInspector

getBrandingIdTerms, getBrandingTerms, getLicenseTerms, getProviderIdTerms, getProviderTerms

Method Detail

getMeterIdTerms

IdTerm[] getMeterIdTerms()

Gets the meter Id terms.

Returns:

the meter Id terms

Compliance:

mandatory - This method must be implemented.

getMeterTerms

MeterQueryInspector[] getMeterTerms()

Gets the meter terms.

Returns:

the meter terms

Compliance:

mandatory - This method must be implemented.

getAncestorUtilityIdTerms

IdTerm[] getAncestorUtilityIdTerms()

Gets the ancestor utility Id terms.

Returns:

the utility Id terms

Compliance:

mandatory - This method must be implemented.

getAncestorUtilityTerms

UtilityQueryInspector[] getAncestorUtilityTerms()

Gets the ancestor utility terms.

Returns:

the utility terms

Compliance:

mandatory - This method must be implemented.

getDescendantUtilityIdTerms

IdTerm[] getDescendantUtilityIdTerms()

Gets the descendant utility Id terms.

Returns:

the utility Id terms

Compliance:

mandatory - This method must be implemented.

getDescendantUtilityTerms

UtilityQueryInspector[] getDescendantUtilityTerms()

Gets the descendant utility terms.

Returns:

the utility terms

Compliance:

mandatory - This method must be implemented.

getUtilityQueryInspectorRecord

UtilityQueryInspectorRecord getUtilityQueryInspectorRecord(Type utilityRecordType)
                                                           throws OperationFailedException

Gets the utility query record interface corresponding to the given Utility record Type. Multiple retrievals produce a nested OR term.

Parameters:

utilityRecordType - a utility record type

Returns:

the utility query inspector record

Throws:

NullArgumentException - utilityRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(utilityRecordType) is false

Compliance:

mandatory - This method must be implemented.