OSID Logo
OSID Specifications
billing package
Version 3.0.0
Release Candidate Preview
Interfaceosid.billing.EntryQueryInspector
Implementsosid.OsidRelationshipQueryInspector
Description

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.

MethodgetCustomerIdTerms
Description

Gets the item Id query terms.

Returnosid.search.terms.IdTerm[]the item Id query terms
CompliancemandatoryThis method must be implemented.
MethodgetCustomerTerms
Description

Gets the item query terms.

Returnosid.billing.CustomerQueryInspector[]the item query terms
CompliancemandatoryThis method must be implemented.
MethodgetItemIdTerms
Description

Gets the item Id query terms.

Returnosid.search.terms.IdTerm[]the item Id query terms
CompliancemandatoryThis method must be implemented.
MethodgetItemTerms
Description

Gets the item query terms.

Returnosid.billing.ItemQueryInspector[]the item query terms
CompliancemandatoryThis method must be implemented.
MethodgetPeriodIdTerms
Description

Gets the period Id query terms.

Returnosid.search.terms.IdTerm[]the period Id query terms
CompliancemandatoryThis method must be implemented.
MethodgetPeriodTerms
Description

Gets the period query terms.

Returnosid.billing.PeriodQueryInspector[]the period query terms
CompliancemandatoryThis method must be implemented.
MethodgetQuantityTerms
Description

Gets the quantity terms.

Returnosid.search.terms.CardinalRangeTerm[]the quantity terms
CompliancemandatoryThis method must be implemented.
MethodgetAmountTerms
Description

Gets the amount query terms.

Returnosid.search.terms.CurrencyRangeTerm[]the amount query terms
CompliancemandatoryThis method must be implemented.
MethodgetDebitTerms
Description

Gets the debit query terms.

Returnosid.search.terms.BooleanTerm[]the debit query terms
CompliancemandatoryThis method must be implemented.
MethodgetBusinessIdTerms
Description

Gets the business Id query terms.

Returnosid.search.terms.IdTerm[]the business Id query terms
CompliancemandatoryThis method must be implemented.
MethodgetBusinessTerms
Description

Gets the business query terms.

Returnosid.billing.BusinessQueryInspector[]the business query terms
CompliancemandatoryThis method must be implemented.
MethodgetEntryQueryInspectorRecord
Description

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

Parametersosid.type.TypeentryRecordTypean entry record type
Returnosid.billing.records.EntryQueryInspectorRecordthe entry query inspector record
ErrorsNULL_ARGUMENT entryRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(entryRecordType) is false
CompliancemandatoryThis method must be implemented.