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

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

MethodmatchEntryId
Description

Sets the entry Id for this query to match categories 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 any related entry.

Parametersbooleanmatch true to match categories with any entry, false to match categories with no entries
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 categories 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.
MethodgetCategoryQueryRecord
Description

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

Parametersosid.type.TypecategoryRecordTypea category record type
Returnosid.billing.records.CategoryQueryRecordthe category query record
ErrorsNULL_ARGUMENT categoryRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(categoryRecordType) is false
CompliancemandatoryThis method must be implemented.