OSID Specifications
financials package
Version 3.0.0
Release Candidate Preview
financials package
Version 3.0.0
Release Candidate Preview
| Interface | osid.financials.AccountSearchResults | ||
|---|---|---|---|
| Implements | osid.OsidSearchResults | ||
| Description |
This interface provides a means to capture results of a search. | ||
| Method | getAccounts | ||
| Description |
Gets the account list resulting from a search. | ||
| Return | osid.financials.AccountList | the account list | |
| Errors | ILLEGAL_STATE | the account list has already been retrieved | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getAccountQueryInspector | ||
| Description |
Gets the inspector for the query to examine the terms used in the search. | ||
| Return | osid.financials.AccountQueryInspector | the query inspector | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getAccountSearchResultsRecord | ||
| Description |
Gets the account search results record corresponding to
the given account search record | ||
| Parameters | osid.type.Type | accountSearchRecordType | a account search record type |
| Return | osid.financials.records.AccountSearchResultsRecord | the account search results record | |
| Errors | NULL_ARGUMENT | accountSearchRecordType is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNSUPPORTED | hasRecordType(accountSearchRecordType) is false
| ||
| Compliance | mandatory | This method must be implemented. | |