OSID Logo
OSID Specifications
billing package
Version 3.1.0
Interfaceosid.billing.PeriodQueryInspector
Implementsosid.OsidObjectQueryInspector
Used Byosid.billing.BusinessQueryInspector
osid.billing.EntryQueryInspector
osid.billing.PeriodSearchResults
osid.billing.PeriodSmartBusinessSession
osid.billing.payment.PaymentQueryInspector
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, PeriodQueryInspector is stateful and must not be accessed by multiple processing threads.

MethodgetDisplayLabelTerms
Description

Gets the display label query terms.

Returnosid.search.terms.StringTerm[] the display labelquery terms
Compliancemandatory This method must be implemented.
MethodgetOpenDateTerms
Description

Gets the open date query terms.

Returnosid.search.terms.DateTimeRangeTerm[] the open date query terms
Compliancemandatory This method must be implemented.
MethodgetCloseDateTerms
Description

Gets the close date query terms.

Returnosid.search.terms.DateTimeRangeTerm[] the close date query terms
Compliancemandatory This method must be implemented.
MethodgetBillingDateTerms
Description

Gets the billing date query terms.

Returnosid.search.terms.DateTimeRangeTerm[] the billing date query terms
Compliancemandatory This method must be implemented.
MethodgetDueDateTerms
Description

Gets the dur date query terms.

Returnosid.search.terms.DateTimeRangeTerm[] the dur date 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.
MethodgetPeriodQueryInspectorRecord
Description

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

Parametersosid.type.TypeperiodRecordType a period record type
Returnosid.billing.records.PeriodQueryInspectorRecord the period query inspector record
ErrorsNULL_ARGUMENT periodRecordType is null
OPERATION_FAILED unable to complete request
UNSUPPORTED hasRecordType(periodRecordType) is false
Compliancemandatory This method must be implemented.