OSID Logo
OSID Specifications
billing package
Version 3.0.0
Release Candidate Preview
Interfaceosid.billing.EntryQuery
Implementsosid.OsidRelationshipQuery
Description

This is the query for searching entries. Each method match specifies an AND term while multiple invocations of the same method produce a nested OR.

MethodmatchCustomerId
Description

Sets the customer Id for this query.

Parametersosid.id.IdcustomerIda customer Id
booleanmatch true if a positive match, false for a negative match
ErrorsNULL_ARGUMENT customerId is null
CompliancemandatoryThis method must be implemented.
MethodclearCustomerIdTerms
Description

Clears the customer Id terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsCustomerQuery
Description

Tests if a CustomerQuery is available.

Returnboolean true if a customer query is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetCustomerQuery
Description

Gets the query for a customer. Multiple retrievals produce a nested OR term.

Returnosid.billing.CustomerQuerythe customer query
ErrorsUNIMPLEMENTED supportsCustomerQuery() is false
ComplianceoptionalThis method must be implemented if supportsCustomerQuery() is true.
MethodclearCustomerTerms
Description

Clears the customer terms.

CompliancemandatoryThis method must be implemented.
MethodmatchItemId
Description

Sets the item Id for this query.

Parametersosid.id.IditemIdan item Id
booleanmatch true if a positive match, false for a negative match
ErrorsNULL_ARGUMENT itemId is null
CompliancemandatoryThis method must be implemented.
MethodclearItemIdTerms
Description

Clears the item Id terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsItemQuery
Description

Tests if an ItemQuery is available.

Returnboolean true if an item query is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetItemQuery
Description

Gets the query for an item. Multiple retrievals produce a nested OR term.

Returnosid.billing.ItemQuerythe item query
ErrorsUNIMPLEMENTED supportsItemQuery() is false
ComplianceoptionalThis method must be implemented if supportsItemQuery() is true.
MethodclearItemTerms
Description

Clears the item terms.

CompliancemandatoryThis method must be implemented.
MethodmatchPeriodId
Description

Sets the period Id for this query to match categories that have a related term.

Parametersosid.id.IdperiodIda billing period Id
booleanmatch true if a positive match, false for a negative match
ErrorsNULL_ARGUMENT periodId is null
CompliancemandatoryThis method must be implemented.
MethodclearPeriodIdTerms
Description

Clears the period Id terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsPeriodQuery
Description

Tests if a PeriodQuery is available.

Returnboolean true if a period query is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetPeriodQuery
Description

Gets the query for a reporting period. Multiple retrievals produce a nested OR term.

Returnosid.billing.PeriodQuerythe period query
ErrorsUNIMPLEMENTED supportsPeriodQuery() is false
ComplianceoptionalThis method must be implemented if supportsPeriodQuery() is true.
MethodclearPeriodTerms
Description

Clears the period terms.

CompliancemandatoryThis method must be implemented.
MethodmatchQuantity
Description

Matches entries with a quantity between the given range inclusive.

Parameterscardinallowstart of range
cardinalhighend of range
booleanmatch true if a positive match, false for a negative match
ErrorsINVALID_ARGUMENT low is greater than high
CompliancemandatoryThis method must be implemented.
MethodclearQuantityTerms
Description

Clears the quantity terms.

CompliancemandatoryThis method must be implemented.
MethodmatchAmount
Description

Matches the amount between the given range inclusive.

Parametersosid.financials.Currencylowstart of range
osid.financials.Currencyhighend of range
booleanmatch true for a positive match, false for a negative match
ErrorsINVALID_ARGUMENT low is greater than high
NULL_ARGUMENT low or high is null
CompliancemandatoryThis method must be implemented.
MethodmatchAnyAmount
Description

Matches items that have any amount set.

Parametersbooleanmatch true to match items with any amount, false to match items with no amount
CompliancemandatoryThis method must be implemented.
MethodclearAmountTerms
Description

Clears the amount terms.

CompliancemandatoryThis method must be implemented.
MethodmatchDebit
Description

Matches items that have debit amounts.

Parametersbooleanmatch true to match items with a debit amount, false to match items with a credit amount
CompliancemandatoryThis method must be implemented.
MethodclearDebitTerms
Description

Clears the debit terms.

CompliancemandatoryThis method must be implemented.
MethodmatchBusinessId
Description

Sets the business Id for this query to match entries assigned to businesses.

Parametersosid.id.IdbusinessIdthe business Id
booleanmatch true for a positive match, false for a negative match
ErrorsNULL_ARGUMENT businessId is null
CompliancemandatoryThis method must be implemented.
MethodclearBusinessIdTerms
Description

Clears the business Id terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsBusinessQuery
Description

Tests if a BusinessQuery is available.

Returnboolean true if a business query is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetBusinessQuery
Description

Gets the query for a business. Multiple retrievals produce a nested OR term.

Returnosid.billing.BusinessQuerythe business query
ErrorsUNIMPLEMENTED supportsBusinessQuery() is false
ComplianceoptionalThis method must be implemented if supportsBusinessQuery() is true.
MethodclearBusinessTerms
Description

Clears the business terms.

CompliancemandatoryThis method must be implemented.
MethodgetEntryQueryRecord
Description

Gets the entry query record corresponding to the given Entry record Type. Multiple record retrievals produce a nested OR term.

Parametersosid.type.TypeentryRecordTypean entry record type
Returnosid.billing.records.EntryQueryRecordthe entry query record
ErrorsNULL_ARGUMENT entryRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(entryRecordType) is false
CompliancemandatoryThis method must be implemented.