| Interface | osid.financials.AccountSearch | ||
|---|---|---|---|
| Implements | osid.OsidSearch | ||
| Description |
The search interface for governing account searches. | ||
| Method | searchAmongAccounts | ||
| Description |
Execute this search among the given list of accounts. | ||
| Parameters | osid.id.IdList | accountIds | list of accounts |
| Errors | NULL_ARGUMENT | accountIds is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | orderAccountResults | ||
| Description |
Specify an ordering to the search results. | ||
| Parameters | osid.financials.AccountSearchOrder | accountSearchOrder | account search order |
| Errors | NULL_ARGUMENT | accountSearchOrder is null | |
| UNSUPPORTED | accountSearchOrder is not of this service | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | getAccountSearchRecord | ||
| Description |
Gets the account search record corresponding to the
given account search record | ||
| Parameters | osid.type.Type | accountSearchRecordType | a account search record type |
| Return | osid.financials.records.AccountSearchRecord | the account search 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. | |