org.osid.acknowledgement

Interface BillingQueryInspector

All Superinterfaces:

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

public interface BillingQueryInspector
extends OsidCatalogQueryInspector

The query inspectors provide a means of accessing the match terms of a query. These interfaces are used to examine the actual query terms used in a search or that may be used to create a smart catalog. Query inspectors may be converted to OsidQuery interfaces for reuse or modification in the search sessions.

Method Summary

Methods

Modifier and Type	Method and Description
IdTerm[]	getAncestorBillingIdTerms() Gets the ancestor billing Id query terms.
BillingQueryInspector[]	getAncestorBillingTerms() Gets the ancestor billing query terms.
BillingQueryInspectorRecord	getBillingQueryInspectorRecord(Type billingRecordType) Gets the record query inspector record corresponding to the given Billing record Type.
IdTerm[]	getCreditIdTerms() Gets the credit Id query terms.
CreditQueryInspector[]	getCreditTerms() Gets the credit query terms.
IdTerm[]	getDescendantBillingIdTerms() Gets the descendant billing Id query terms.
BillingQueryInspector[]	getDescendantBillingTerms() Gets the descendant billing query terms.

Methods inherited from interface org.osid.OsidObjectQueryInspector

getCommentIdTerms, getCommentTerms, 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

getCreditIdTerms

IdTerm[] getCreditIdTerms()

Gets the credit Id query terms.

Specified by:

getCreditIdTerms in interface OsidObjectQueryInspector

Returns:

the credit Id terms

Compliance:

mandatory - This method must be implemented.

getCreditTerms

CreditQueryInspector[] getCreditTerms()

Gets the credit query terms.

Specified by:

getCreditTerms in interface OsidObjectQueryInspector

Returns:

the credit terms

Compliance:

mandatory - This method must be implemented.

getAncestorBillingIdTerms

IdTerm[] getAncestorBillingIdTerms()

Gets the ancestor billing Id query terms.

Returns:

the ancestor billing Id terms

Compliance:

mandatory - This method must be implemented.

getAncestorBillingTerms

BillingQueryInspector[] getAncestorBillingTerms()

Gets the ancestor billing query terms.

Returns:

the ancestor billing terms

Compliance:

mandatory - This method must be implemented.

getDescendantBillingIdTerms

IdTerm[] getDescendantBillingIdTerms()

Gets the descendant billing Id query terms.

Returns:

the descendant billing Id terms

Compliance:

mandatory - This method must be implemented.

getDescendantBillingTerms

BillingQueryInspector[] getDescendantBillingTerms()

Gets the descendant billing query terms.

Returns:

the descendant billing terms

Compliance:

mandatory - This method must be implemented.

getBillingQueryInspectorRecord

BillingQueryInspectorRecord getBillingQueryInspectorRecord(Type billingRecordType)
                                                           throws OperationFailedException

Gets the record query inspector record corresponding to the given Billing record Type.

Parameters:

billingRecordType - a billing record type

Returns:

the billing query inspector record

Throws:

NullArgumentException - billingRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(billingRecordType) is false

Compliance:

mandatory - This method must be implemented.