OSID Logo
OSID Specifications
billing package
Version 3.0.0
Release Candidate Preview
Interfaceosid.billing.BusinessQueryInspector
Implementsosid.OsidCatalogQueryInspector
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 customer Id query terms.

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

Gets the customer query terms.

Returnosid.billing.CustomerQueryInspector[]the customer 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.
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.
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.
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.
MethodgetAncestorBusinessIdTerms
Description

Gets the ancestor business Id query terms.

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

Gets the ancestor business query terms.

Returnosid.billing.BusinessQueryInspector[]the ancestor business terms
CompliancemandatoryThis method must be implemented.
MethodgetDescendantBusinessIdTerms
Description

Gets the descendant business Id query terms.

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

Gets the descendant business query terms.

Returnosid.billing.BusinessQueryInspector[]the descendant business terms
CompliancemandatoryThis method must be implemented.
MethodgetBusinessQueryInspectorRecord
Description

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

Parametersosid.type.TypebusinessRecordTypea business record type
Returnosid.billing.records.BusinessQueryInspectorRecordthe business query inspector record
ErrorsNULL_ARGUMENT businessRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(businessRecordType) is false
CompliancemandatoryThis method must be implemented.