| Interface | osid.billing.CategoryQuery | ||
|---|---|---|---|
| Implements | osid.OsidObjectQuery | ||
| Description |
This is the query for searching categories. Each method
match specifies an | ||
| Method | matchEntryId | ||
| Description |
Sets the entry | ||
| Parameters | osid.id.Id | entryId | an entry Id |
boolean | match | true if a positive match, false for a
negative match | |
| Errors | NULL_ARGUMENT | entryId is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | clearEntryIdTerms | ||
| Description |
Clears the entry | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | supportsEntryQuery | ||
| Description |
Tests if an | ||
| Return | boolean | true if an entry query is available, false
otherwise | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getEntryQuery | ||
| Description |
Gets the query for an entry. Multiple retrievals
produce a nested | ||
| Return | osid.billing.EntryQuery | the entry query | |
| Errors | UNIMPLEMENTED | supportsEntryQuery() is false | |
| Compliance | optional | This method must be implemented if supportsEntryQuery() is
true. | |
| Method | matchAnyEntry | ||
| Description |
Matches any related entry. | ||
| Parameters | boolean | match | true to match categories with any entry, false
to match categories with no entries |
| Compliance | mandatory | This method must be implemented. | |
| Method | clearEntryTerms | ||
| Description |
Clears the entry terms. | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | matchBusinessId | ||
| Description |
Sets the business | ||
| Parameters | osid.id.Id | businessId | the business Id |
boolean | match | true for a positive match, false for a
negative match | |
| Errors | NULL_ARGUMENT | businessId is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | clearBusinessIdTerms | ||
| Description |
Clears the business | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | supportsBusinessQuery | ||
| Description |
Tests if a | ||
| Return | boolean | true if a business query is available, false
otherwise | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getBusinessQuery | ||
| Description |
Gets the query for a business. Multiple retrievals
produce a nested | ||
| Return | osid.billing.BusinessQuery | the business query | |
| Errors | UNIMPLEMENTED | supportsBusinessQuery() is false | |
| Compliance | optional | This method must be implemented if supportsBusinessQuery()
is true. | |
| Method | clearBusinessTerms | ||
| Description |
Clears the business terms. | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | getCategoryQueryRecord | ||
| Description |
Gets the category query record corresponding to the
given | ||
| Parameters | osid.type.Type | categoryRecordType | a category record type |
| Return | osid.billing.records.CategoryQueryRecord | the category query record | |
| Errors | NULL_ARGUMENT | categoryRecordType is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNSUPPORTED | hasRecordType(categoryRecordType) is false | ||
| Compliance | mandatory | This method must be implemented. | |