| Interface | osid.financials.AccountSearchSession | ||
|---|---|---|---|
| Implements | osid.financials.AccountQuerySession | ||
| Used By | osid.financials.FinancialsManager | ||
osid.financials.FinancialsProxyManager | |||
| Description |
This session provides methods for searching among
getAccountsByQuery() is the basic search method
and returns a list of Accounts. A more advanced
search may be performed with
getAccountsBySearch().It accepts an
AccountSearch in addition to the query for the
purpose of specifying additional options affecting the entire
search, such as ordering. getAccountsBySearch()
returns an AccountSearchResults that can be used
to access the resulting AccountList or be used to
perform a search within the result set through
AccountSearch.
This session defines views that offer differing behaviors for searching.
Accounts may have a query record indicated by their
respective record types. The query record is accessed via the
| ||
| Method | getAccountSearch | ||
| Description |
Gets an account search. | ||
| Return | osid.financials.AccountSearch | the account search | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getAccountSearchOrder | ||
| Description |
Gets an activity search order. The
| ||
| Return | osid.financials.AccountSearchOrder | the account search order | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getAccountsBySearch | ||
| Description |
Gets the search results matching the given search query using the given search. | ||
| Parameters | osid.financials.AccountQuery | accountQuery | the account query |
osid.financials.AccountSearch | accountSearch | the account search | |
| Return | osid.financials.AccountSearchResults | the account search results | |
| Errors | NULL_ARGUMENT | accountQuery or accountSearch is
null | |
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| UNSUPPORTED | accountQuery or accountSearch is not of this
service | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | getAccountQueryFromInspector | ||
| Description |
Gets an account query from an inspector. The inspector
is available from an | ||
| Parameters | osid.assessment.ItemQueryInspector | accountQueryInspector | an account query inspector |
| Return | osid.financials.AccountQuery | the account query | |
| Errors | NULL_ARGUMENT | accountQueryInspector is null | |
| UNSUPPORTED | accountQueryInspector is not of this service | ||
| Compliance | mandatory | This method must be implemented. | |