Interface FrontOfficeSearchSession

All Superinterfaces:

AutoCloseable, Closeable, FrontOfficeQuerySession, OsidSession, OsidSession

public interface FrontOfficeSearchSession
extends FrontOfficeQuerySession

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

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

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

Method Summary

Modifier and Type	Method	Description
FrontOfficeQuery	getFrontOfficeQueryFromInspector(FrontOfficeQueryInspector frontOfficeQueryInspector)	Gets a front office query from an inspector.
FrontOfficeSearchResults	getFrontOfficesBySearch(FrontOfficeQuery frontOfficeQuery, FrontOfficeSearch frontOfficeSearch)	Gets the search results matching the given search query using the given search.
FrontOfficeSearch	getFrontOfficeSearch()	Gets a front office search.
FrontOfficeSearchOrder	getFrontOfficeSearchOrder()	Gets a front office search order.

Methods inherited from interface Closeable

close

Methods inherited from interface FrontOfficeQuerySession

canSearchFrontOffices, getFrontOfficeQuery, getFrontOfficesByQuery

Modifier and Type	Method	Description
boolean	canSearchFrontOffices()	Tests if this user can perform FrontOffice searches.
FrontOfficeQuery	getFrontOfficeQuery()	Gets a front office query.
FrontOfficeList	getFrontOfficesByQuery(FrontOfficeQuery frontOfficeQuery)	Gets a list of FrontOffices matching the given fromt office query.

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

getFrontOfficeSearch

FrontOfficeSearch getFrontOfficeSearch()

Gets a front office search.

Returns:

the front office search

Compliance:

mandatory - This method must be implemented.

getFrontOfficeSearchOrder

FrontOfficeSearchOrder getFrontOfficeSearchOrder()

Gets a front office search order. The FrontOfficeSearchOrder is supplied to a FrontOfficeSearch to specify the ordering of results.

Returns:

the front office search order

Compliance:

mandatory - This method must be implemented.

getFrontOfficesBySearch

FrontOfficeSearchResults getFrontOfficesBySearch(FrontOfficeQuery frontOfficeQuery,
 FrontOfficeSearch frontOfficeSearch)
                                          throws OperationFailedException,
PermissionDeniedException

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

Parameters:

frontOfficeQuery - the front office query

frontOfficeSearch - the front office search

Returns:

the returned search results

Throws:

NullArgumentException - frontOfficeQuery or frontOfficeSearch is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - frontOfficeQuery or frontOfficeSearch is not of this service

Compliance:

mandatory - This method must be implemented.

getFrontOfficeQueryFromInspector

FrontOfficeQuery getFrontOfficeQueryFromInspector(FrontOfficeQueryInspector frontOfficeQueryInspector)

Gets a front office query from an inspector. The inspector is available from a FrontOfficeSearchResults.

Parameters:

frontOfficeQueryInspector - a front office query inspector

Returns:

the front office query

Throws:

NullArgumentException - frontOfficeQueryInspector is null

UnsupportedException - frontOfficeQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.