OSID Logo
OSID Specifications
billing package
Version 3.0.0
Release Candidate Preview
Interfaceosid.billing.ItemQuery
Implementsosid.OsidObjectQuery
Description

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

MethodmatchCategoryId
Description

Sets the category Id for this query.

Parametersosid.id.IdcategoryIda category Id
booleanmatch true if a positive match, false for a negative match
ErrorsNULL_ARGUMENT categoryId is null
CompliancemandatoryThis method must be implemented.
MethodclearCategoryIdTerms
Description

Clears the category Id terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsCategoryQuery
Description

Tests if a CategoryQuery is available.

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

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

Returnosid.billing.CategoryQuerya category query
ErrorsUNIMPLEMENTED supportsCategoryQuery() is false
ComplianceoptionalThis method must be implemented if supportscategoryQuery() is true.
MethodclearCategoryTerms
Description

Clears the category terms.

CompliancemandatoryThis method must be implemented.
MethodmatchAccountId
Description

Sets the account Id for this query to match items that have a related financial account.

Parametersosid.id.IdaccountIdan account Id
booleanmatch true if a positive match, false for a negative match
ErrorsNULL_ARGUMENT accountId is null
CompliancemandatoryThis method must be implemented.
MethodclearAccountIdTerms
Description

Clears the account Id terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsAccountQuery
Description

Tests if an AccountQuery is available.

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

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

Returnosid.financials.AccountQuerythe account query
ErrorsUNIMPLEMENTED supportsAccountQuery() is false
ComplianceoptionalThis method must be implemented if supportsAccountQuery() is true.
MethodmatchAnyAccount
Description

Matches items that have any account.

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

Clears the account terms.

CompliancemandatoryThis method must be implemented.
MethodmatchProductId
Description

Sets the product Id for this query to match items that have a related product.

Parametersosid.id.IdproductIda product Id
booleanmatch true if a positive match, false for a negative match
ErrorsNULL_ARGUMENT productId is null
CompliancemandatoryThis method must be implemented.
MethodclearProductIdTerms
Description

Clears the account Id terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsProductQuery
Description

Tests if a ProductQuery is available.

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

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

Returnosid.ordering.ProductQuerythe product query
ErrorsUNIMPLEMENTED supportsProductQuery() is false
ComplianceoptionalThis method must be implemented if supportsProductQuery() is true.
MethodmatchAnyProduct
Description

Matches items that have any product.

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

Clears the product 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.
MethodmatchRecurringInterval
Description

Matches the recurring interval between the given range inclusive.

Parametersosid.calendaring.Durationlowstart of range
osid.calendaring.Durationhighend 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.
MethodmatchAnyRecurringInterval
Description

Matches items that have any recurring interval.

Parametersbooleanmatch true to match items with any recurring interval, false to match items with a one-time charge
CompliancemandatoryThis method must be implemented.
MethodclearRecurringIntervalTerms
Description

Clears the amount terms.

CompliancemandatoryThis method must be implemented.
MethodmatchEntryId
Description

Sets the entry Id for this query to match items that have a related entry.

Parametersosid.id.IdentryIdan entry Id
booleanmatch true if a positive match, false for a negative match
ErrorsNULL_ARGUMENT entryId is null
CompliancemandatoryThis method must be implemented.
MethodclearEntryIdTerms
Description

Clears the entry Id terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsEntryQuery
Description

Tests if an EntryQuery is available.

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

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

Returnosid.billing.EntryQuerythe entry query
ErrorsUNIMPLEMENTED supportsEntryQuery() is false
ComplianceoptionalThis method must be implemented if supportsEntryQuery() is true.
MethodmatchAnyEntry
Description

Matches items that have any entry.

Parametersbooleanmatch true to match items with any entry. false to match items with no entry
CompliancemandatoryThis method must be implemented.
MethodclearEntryTerms
Description

Clears the entry terms.

CompliancemandatoryThis method must be implemented.
MethodmatchBusinessId
Description

Sets the business Id for this query to match customers 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.
MethodgetItemQueryRecord
Description

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

Parametersosid.type.TypeitemRecordTypean item record type
Returnosid.billing.records.ItemQueryRecordthe item query record
ErrorsNULL_ARGUMENT itemRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(itemRecordType) is false
CompliancemandatoryThis method must be implemented.