OSID Logo
OSID Specifications
financials package
Version 3.0.0
Release Candidate Preview
Interfaceosid.financials.AccountSearchSession
Implementsosid.financials.AccountQuerySession
Description

This session provides methods for searching among Account objects. The search query is constructed using the AccountQuery.

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.

  • federated business view: searches include accounts in businesses of which this business is an ancestor in the business hierarchy
  • isolated business view: searches are restricted to accounts in this business

Accounts may have a query record indicated by their respective record types. The query record is accessed via the AccountQuery.

MethodgetAccountSearch
Description

Gets an account search.

Returnosid.financials.AccountSearchthe account search
CompliancemandatoryThis method must be implemented.
MethodgetAccountSearchOrder
Description

Gets an activity search order. The AccountSearchOrder is supplied to an AccountSearch to specify the ordering of results.

Returnosid.financials.AccountSearchOrderthe account search order
CompliancemandatoryThis method must be implemented.
MethodgetAccountsBySearch
Description

Gets the search results matching the given search query using the given search.

Parametersosid.financials.AccountQueryaccountQuerythe account query
osid.financials.AccountSearchaccountSearchthe account search
Returnosid.financials.AccountSearchResultsthe account search results
ErrorsNULL_ARGUMENT accountQuery or accountSearch is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED accountQuery or accountSearch is not of this service
CompliancemandatoryThis method must be implemented.
MethodgetAccountQueryFromInspector
Description

Gets an account query from an inspector. The inspector is available from an AccountSearchResults.

Parametersosid.assessment.ItemQueryInspectoraccountQueryInspectoran account query inspector
Returnosid.financials.AccountQuerythe account query
ErrorsNULL_ARGUMENT accountQueryInspector is null
UNSUPPORTED accountQueryInspector is not of this service
CompliancemandatoryThis method must be implemented.