org.osid.financials

Interface AccountSearchSession

All Superinterfaces:

AccountQuerySession, java.lang.AutoCloseable, java.io.Closeable, OsidSession

public interface AccountSearchSession
extends AccountQuerySession

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.

Method Summary

Methods

Modifier and Type	Method and Description
AccountQuery	getAccountQueryFromInspector(ItemQueryInspector accountQueryInspector) Gets an account query from an inspector.
AccountSearchResults	getAccountsBySearch(AccountQuery accountQuery, AccountSearch accountSearch) Gets the search results matching the given search query using the given search.
AccountSearch	getAccountSearch() Gets an account search.
AccountSearchOrder	getAccountSearchOrder() Gets an activity search order.

Methods inherited from interface org.osid.financials.AccountQuerySession

canSearchAccounts, getAccountQuery, getAccountsByQuery, getBusiness, getBusinessId, useFederatedBusinessView, useIsolatedBusinessView

Methods inherited from interface org.osid.OsidSession

getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions

Methods inherited from interface org.osid.binding.java.OsidSession

close

Methods inherited from interface java.io.Closeable

close

Method Detail

getAccountSearch

AccountSearch getAccountSearch()

Gets an account search.

Returns:

the account search

Compliance:

mandatory - This method must be implemented.

getAccountSearchOrder

AccountSearchOrder getAccountSearchOrder()

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

Returns:

the account search order

Compliance:

mandatory - This method must be implemented.

getAccountsBySearch

AccountSearchResults getAccountsBySearch(AccountQuery accountQuery,
                                       AccountSearch accountSearch)
                                         throws OperationFailedException,
                                                PermissionDeniedException

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

Parameters:

accountQuery - the account query

accountSearch - the account search

Returns:

the account search results

Throws:

NullArgumentException - accountQuery or accountSearch is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - accountQuery or accountSearch is not of this service

Compliance:

mandatory - This method must be implemented.

getAccountQueryFromInspector

AccountQuery getAccountQueryFromInspector(ItemQueryInspector accountQueryInspector)

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

Parameters:

accountQueryInspector - an account query inspector

Returns:

the account query

Throws:

NullArgumentException - accountQueryInspector is null

UnsupportedException - accountQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.