OSID Logo
OSID Specifications
financials package
Version 3.0.0
Release Candidate Preview
Interfaceosid.financials.AccountSearchResults
Implementsosid.OsidSearchResults
Description

This interface provides a means to capture results of a search.

MethodgetAccounts
Description

Gets the account list resulting from a search.

Returnosid.financials.AccountListthe account list
ErrorsILLEGAL_STATEthe account list has already been retrieved
CompliancemandatoryThis method must be implemented.
MethodgetAccountQueryInspector
Description

Gets the inspector for the query to examine the terms used in the search.

Returnosid.financials.AccountQueryInspectorthe query inspector
CompliancemandatoryThis method must be implemented.
MethodgetAccountSearchResultsRecord
Description

Gets the account search results record corresponding to the given account search record Type. This method is used to retrieve an object implementing the requested record.

Parametersosid.type.TypeaccountSearchRecordTypea account search record type
Returnosid.financials.records.AccountSearchResultsRecordthe account search results record
ErrorsNULL_ARGUMENT accountSearchRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(accountSearchRecordType) is false
CompliancemandatoryThis method must be implemented.