Interface | osid.billing.CategorySearchResults | ||
---|---|---|---|
Implements | osid.OsidSearchResults | ||
Description |
This interface provides a means to capture results of a search. | ||
Method | getCategories | ||
Description |
Gets the category list resulting from a search. | ||
Return | osid.billing.CategoryList | the category list | |
Errors | ILLEGAL_STATE | the category list has already been retrieved | |
Compliance | mandatory | This method must be implemented. | |
Method | getCategoryQueryInspector | ||
Description |
Gets the inspector for the query to examine the periods used in the search. | ||
Return | osid.billing.CategoryQueryInspector | the query inspector | |
Compliance | mandatory | This method must be implemented. | |
Method | getCategorySearchResultsRecord | ||
Description |
Gets the category search results record corresponding
to the given category search record | ||
Parameters | osid.type.Type | categorySearchRecordType | a category search record type |
Return | osid.billing.records.CategorySearchResultsRecord | the category search results record | |
Errors | NULL_ARGUMENT | categorySearchRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
UNSUPPORTED | hasRecordType(categorySearchRecordType) is false
| ||
Compliance | mandatory | This method must be implemented. |