OSID Logo
OSID Specifications
billing package
Version 3.1.0
Interfaceosid.billing.CategoryQueryInspector
Implementsosid.OsidObjectQueryInspector
Used Byosid.billing.BusinessQueryInspector
osid.billing.CategorySearchResults
osid.billing.CategorySmartBusinessSession
osid.billing.ItemQueryInspector
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.

Like all OsidQueryInspectors, CategoryQueryInspector is stateful and must not be accessed by multiple processing threads.

MethodgetEntryIdTerms
Description

Gets the entry Id query terms.

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

Gets the entry query terms.

Returnosid.billing.EntryQueryInspector[] the entry query terms
Compliancemandatory This method must be implemented.
MethodgetBusinessIdTerms
Description

Gets the business Id query terms.

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

Gets the business query terms.

Returnosid.billing.BusinessQueryInspector[] the business query terms
Compliancemandatory This method must be implemented.
MethodgetCategoryQueryInspectorRecord
Description

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

Parametersosid.type.TypecategoryRecordType a category record type
Returnosid.billing.records.CategoryQueryInspectorRecord the category query inspector record
ErrorsNULL_ARGUMENT categoryRecordType is null
OPERATION_FAILED unable to complete request
UNSUPPORTED hasRecordType(categoryRecordType) is false
Compliancemandatory This method must be implemented.