org.osid.financials

Interface BusinessSearchSession

All Superinterfaces:

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

public interface BusinessSearchSession
extends BusinessQuerySession

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

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

Methods

Modifier and Type	Method and 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 org.osid.financials.BusinessQuerySession

canSearchBusinesses, getBusinessesByQuery, getBusinessQuery

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

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.