Interface | osid.billing.BusinessSearchResults | ||
---|---|---|---|
Implements | osid.OsidSearchResults | ||
Description |
This interface provides a means to capture results of a search. | ||
Method | getBusinesses | ||
Description |
Gets the business list resulting from a search. | ||
Return | osid.billing.BusinessList | the business list | |
Errors | ILLEGAL_STATE | the business list has already been retrieved | |
Compliance | mandatory | This method must be implemented. | |
Method | getBusinessQueryInspector | ||
Description |
Gets the inspector for the query to examine the terms used in the search. | ||
Return | osid.billing.BusinessQueryInspector | the query inspector | |
Compliance | mandatory | This method must be implemented. | |
Method | getBusinessSearchResultsRecord | ||
Description |
Gets the business search results record corresponding
to the given business search record | ||
Parameters | osid.type.Type | businessSearchRecordType | a business search record type |
Return | osid.billing.records.BusinessSearchResultsRecord | the business search results record | |
Errors | NULL_ARGUMENT | businessSearchRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
UNSUPPORTED | hasRecordType(businessSearchRecordType) is false
| ||
Compliance | mandatory | This method must be implemented. |