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

MethodgetResourceIdTerms
Description

Gets the resource Id query terms.

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

Gets the resource query terms.

Returnosid.resource.ResourceQueryInspector[]the resource query terms
CompliancemandatoryThis method must be implemented.
MethodgetCustomerNumberTerms
Description

Gets the customer number terms.

Returnosid.search.terms.StringTerm[]the customer number terms
CompliancemandatoryThis method must be implemented.
MethodgetActivityIdTerms
Description

Gets the activity Id query terms.

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

Gets the activity query terms.

Returnosid.financials.ActivityQueryInspector[]the activity 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.
MethodgetCustomerQueryInspectorRecord
Description

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

Parametersosid.type.TypecustomerRecordTypea customer record type
Returnosid.billing.records.CustomerQueryInspectorRecordthe customer query inspector record
ErrorsNULL_ARGUMENT customerRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(customerRecordType) is false
CompliancemandatoryThis method must be implemented.