Interface | osid.financials.BusinessSearchSession | ||
---|---|---|---|
Implements | osid.financials.BusinessQuerySession | ||
Description |
This session provides methods for searching among This session defines views that offer differing behaviors for searching.
businesses may have a query record indicated by their
respective record types. The query record is accessed via the
| ||
Method | getBusinessSearch | ||
Description |
Gets a business search. | ||
Return | osid.financials.BusinessSearch | the business search | |
Compliance | mandatory | This method must be implemented. | |
Method | getBusinessSearchOrder | ||
Description |
Gets a business search order. The | ||
Return | osid.financials.BusinessSearchOrder | the business search order | |
Compliance | mandatory | This method must be implemented. | |
Method | getBusinessesBySearch | ||
Description |
Gets the search results matching the given search query using the given search. | ||
Parameters | osid.financials.BusinessQuery | businessQuery | the business query |
osid.financials.BusinessSearch | businessSearch | the business search | |
Return | osid.financials.BusinessSearchResults | the business search results | |
Errors | NULL_ARGUMENT | businessQuery or businessSearch is
null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | businessQuery or businessSearch is not of
this service | ||
Compliance | mandatory | This method must be implemented. | |
Method | getBusinessQueryFromInspector | ||
Description |
Gets a business query from an inspector. The inspector
is available from a | ||
Parameters | osid.financials.BusinessQueryInspector | businessQueryInspector | a business query inspector |
Return | osid.financials.BusinessQuery | the business query | |
Errors | NULL_ARGUMENT | businessQueryInspector is null | |
UNSUPPORTED | businessQueryInspector is not of this service | ||
Compliance | mandatory | This method must be implemented. |