Interface BusinessSearchSession

All Superinterfaces:

AutoCloseable, BusinessQuerySession, Closeable, OsidSession, OsidSession

public interface BusinessSearchSession
extends BusinessQuerySession

This session provides methods for searching among Businesses . The search query is constructed using the BusinessQuery .

getBusinessesByQuery() is the basic search method and returns a list of Businesses . A more advanced search may be performed with getBusinessesBySearch() .It accepts a BusinessSearch in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. getBusinessesBySearch() returns a BusinessSearchResults that can be used to access the resulting BusinessList or be used to perform a search within the result set through BusinessSearch .

This session defines views that offer differing behaviors for searching.

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

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

Method Summary

Modifier and Type	Method	Description
BusinessSearchResults	getBusinessesBySearch(BusinessQuery businessQuery, BusinessSearch businessSearch)	Gets the search results matching the given search query using the given search.
BusinessQuery	getBusinessQueryFromInspector(BusinessQueryInspector businessQueryInspector)	Gets a business query from an inspector.
BusinessSearch	getBusinessSearch()	Gets a business search.
BusinessSearchOrder	getBusinessSearchOrder()	Gets a business search order.

Methods inherited from interface BusinessQuerySession

canSearchBusinesses, getBusinessesByQuery, getBusinessQuery

Modifier and Type	Method	Description
boolean	canSearchBusinesses()	Tests if this user can perform Business lookups.
BusinessList	getBusinessesByQuery(BusinessQuery businessQuery)	Gets a list of Businesses matching the given business query.
BusinessQuery	getBusinessQuery()	Gets a business query.

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

getBusinessSearch

BusinessSearch getBusinessSearch()

Gets a business search.

Returns:

the business search

Compliance:

mandatory - This method must be implemented.

getBusinessSearchOrder

BusinessSearchOrder getBusinessSearchOrder()

Gets a business search order. The BusinessSearchOrder is supplied to a BusinessSearch to specify the ordering of results.

Returns:

the business search order

Compliance:

mandatory - This method must be implemented.

getBusinessesBySearch

BusinessSearchResults getBusinessesBySearch(BusinessQuery businessQuery,
 BusinessSearch businessSearch)
                                     throws OperationFailedException,
PermissionDeniedException

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

Parameters:

businessQuery - the business query

businessSearch - the business search

Returns:

the business search results

Throws:

NullArgumentException - businessQuery or businessSearch is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - businessQuery or businessSearch is not of this service

Compliance:

mandatory - This method must be implemented.

getBusinessQueryFromInspector

BusinessQuery getBusinessQueryFromInspector(BusinessQueryInspector businessQueryInspector)

Gets a business query from an inspector. The inspector is available from a BusinessSearchResults .

Parameters:

businessQueryInspector - a business query inspector

Returns:

the business query

Throws:

NullArgumentException - businessQueryInspector is null

UnsupportedException - businessQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.