Interface AccountSearchSession

All Superinterfaces:

AccountQuerySession, AutoCloseable, Closeable, OsidSession, OsidSession

public interface AccountSearchSession
extends AccountQuerySession

This session provides methods for searching among Accounts . 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

Modifier and Type	Method	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 AccountQuerySession

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

Modifier and Type	Method	Description
boolean	canSearchAccounts()	Tests if this user can perform Account lookups.
AccountQuery	getAccountQuery()	Gets an account query.
AccountList	getAccountsByQuery(AccountQuery accountsQuery)	Gets a list of Accounts matching the given account query.
Business	getBusiness()	Gets the Business associated with this session.
Id	getBusinessId()	Gets the Business Id associated with this session.
void	useFederatedBusinessView()	Federates the view for methods in this session.
void	useIsolatedBusinessView()	Isolates the view for methods in this session.

Methods inherited from interface Closeable

close

Methods inherited from interface OsidSession

close

Modifier and Type	Method	Description
void	close()	Close this session.

Methods inherited from interface OsidSession

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

Modifier and Type	Method	Description
Agent	getAuthenticatedAgent()	Gets the agent authenticated to this session.
Id	getAuthenticatedAgentId()	Gets the Id of the agent authenticated to this session.
BigDecimal	getClockRate()	Gets the rate of the service clock.
Date	getDate()	Gets the service date which may be the current date or the effective date in which this session exists.
Agent	getEffectiveAgent()	Gets the effective agent in use by this session.
Id	getEffectiveAgentId()	Gets the Id of the effective agent in use by this session.
Type	getFormatType()	Gets the DisplayText format Type preference in effect for this session.
Locale	getLocale()	Gets the locale indicating the localization preferences in effect for this session.
boolean	isAuthenticated()	Tests if an agent is authenticated to this session.
Transaction	startTransaction()	Starts a new transaction for this sesson.
boolean	supportsTransactions()	Tests for the availability of transactions.

Method Details

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.