org.osid.billing

Interface EntryQueryInspector

All Superinterfaces:

Extensible, OsidBrowsableQueryInspector, OsidExtensibleQueryInspector, OsidIdentifiableQueryInspector, OsidObjectQueryInspector, OsidQueryInspector, OsidRelationshipQueryInspector, OsidTemporalQueryInspector

public interface EntryQueryInspector
extends OsidRelationshipQueryInspector

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
CurrencyRangeTerm[]	getAmountTerms() Gets the amount query terms.
IdTerm[]	getBusinessIdTerms() Gets the business Id query terms.
BusinessQueryInspector[]	getBusinessTerms() Gets the business query terms.
IdTerm[]	getCustomerIdTerms() Gets the item Id query terms.
CustomerQueryInspector[]	getCustomerTerms() Gets the item query terms.
BooleanTerm[]	getDebitTerms() Gets the debit query terms.
EntryQueryInspectorRecord	getEntryQueryInspectorRecord(Type entryRecordType) Gets the entry query inspector record corresponding to the given Entry record Type.
IdTerm[]	getItemIdTerms() Gets the item Id query terms.
ItemQueryInspector[]	getItemTerms() Gets the item query terms.
IdTerm[]	getPeriodIdTerms() Gets the period Id query terms.
PeriodQueryInspector[]	getPeriodTerms() Gets the period query terms.
CardinalRangeTerm[]	getQuantityTerms() Gets the quantity terms.

Methods inherited from interface org.osid.OsidRelationshipQueryInspector

getEndReasonIdTerms, getEndReasonTerms

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.OsidTemporalQueryInspector

getDateTerms, getEffectiveTerms, getEndDateTerms, getStartDateTerms

Method Detail

getCustomerIdTerms

IdTerm[] getCustomerIdTerms()

Gets the item Id query terms.

Returns:

the item Id query terms

Compliance:

mandatory - This method must be implemented.

getCustomerTerms

CustomerQueryInspector[] getCustomerTerms()

Gets the item query terms.

Returns:

the item query terms

Compliance:

mandatory - This method must be implemented.

getItemIdTerms

IdTerm[] getItemIdTerms()

Gets the item Id query terms.

Returns:

the item Id query terms

Compliance:

mandatory - This method must be implemented.

getItemTerms

ItemQueryInspector[] getItemTerms()

Gets the item query terms.

Returns:

the item query terms

Compliance:

mandatory - This method must be implemented.

getPeriodIdTerms

IdTerm[] getPeriodIdTerms()

Gets the period Id query terms.

Returns:

the period Id query terms

Compliance:

mandatory - This method must be implemented.

getPeriodTerms

PeriodQueryInspector[] getPeriodTerms()

Gets the period query terms.

Returns:

the period query terms

Compliance:

mandatory - This method must be implemented.

getQuantityTerms

CardinalRangeTerm[] getQuantityTerms()

Gets the quantity terms.

Returns:

the quantity terms

Compliance:

mandatory - This method must be implemented.

getAmountTerms

CurrencyRangeTerm[] getAmountTerms()

Gets the amount query terms.

Returns:

the amount query terms

Compliance:

mandatory - This method must be implemented.

getDebitTerms

BooleanTerm[] getDebitTerms()

Gets the debit query terms.

Returns:

the debit query terms

Compliance:

mandatory - This method must be implemented.

getBusinessIdTerms

IdTerm[] getBusinessIdTerms()

Gets the business Id query terms.

Returns:

the business Id query terms

Compliance:

mandatory - This method must be implemented.

getBusinessTerms

BusinessQueryInspector[] getBusinessTerms()

Gets the business query terms.

Returns:

the business query terms

Compliance:

mandatory - This method must be implemented.

getEntryQueryInspectorRecord

EntryQueryInspectorRecord getEntryQueryInspectorRecord(Type entryRecordType)
                                                       throws OperationFailedException

Gets the entry query inspector record corresponding to the given Entry record Type. Multiple record retrievals produce a nested OR term.

Parameters:

entryRecordType - an entry record type

Returns:

the entry query inspector record

Throws:

NullArgumentException - entryRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(entryRecordType) is false

Compliance:

mandatory - This method must be implemented.