OSID Logo
OSID Specifications
billing package
Version 3.0.0
Release Candidate Preview
Interfaceosid.billing.ItemQueryInspector
Implementsosid.OsidObjectQueryInspector
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.

MethodgetCategoryIdTerms
Description

Gets the category Id query terms.

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

Gets the category query terms.

Returnosid.billing.CategoryQueryInspector[]the category query terms
CompliancemandatoryThis method must be implemented.
MethodgetAccountIdTerms
Description

Gets the account Id query terms.

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

Gets the account query terms.

Returnosid.financials.AccountQueryInspector[]the account query terms
CompliancemandatoryThis method must be implemented.
MethodgetProductIdTerms
Description

Gets the product Id query terms.

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

Gets the product query terms.

Returnosid.ordering.ProductQueryInspector[]the product query terms
CompliancemandatoryThis method must be implemented.
MethodgetAmountTerms
Description

Gets the amount terms.

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

Gets the debit terms.

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

Gets the recurring interval terms.

Returnosid.search.terms.DurationRangeTerm[]the recurring interval terms
CompliancemandatoryThis method must be implemented.
MethodgetEntryIdTerms
Description

Gets the entry Id query terms.

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

Gets the entry query terms.

Returnosid.billing.EntryQueryInspector[]the entry 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.
MethodgetItemQueryInspectorRecord
Description

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

Parametersosid.type.TypeitemRecordTypean item record type
Returnosid.billing.records.ItemQueryInspectorRecordthe item query inspector record
ErrorsNULL_ARGUMENT itemRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(itemRecordType) is false
CompliancemandatoryThis method must be implemented.