Interface FloorSearchSession

All Superinterfaces:

AutoCloseable, Closeable, FloorQuerySession, OsidSession, OsidSession

public interface FloorSearchSession
extends FloorQuerySession

This session provides methods for searching Floors. The search query is constructed using the FloorQuery. The floor record Type also specifies the record for the floor query.

getFloorsByQuery() is the basic search method and returns a list of Floor elements. A more advanced search may be performed with getFloorsBySearch(). It accepts a FloorSearch in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. getFlooreBySearch() returns a FloorSearchResults that can be used to access the resulting FloorList or be used to perform a search within the result set through FloorSearch.

Floors may have a query record indicated by their respective record types. The query record is accessed via the FloorQuery. The returns in this session may not be cast directly to these interfaces.

Method Summary

Modifier and Type	Method	Description
FloorQuery	getFloorQueryFromInspector(FloorQueryInspector floorQueryInspector)	Gets an entry query from an inspector.
FloorSearchResults	getFloorsBySearch(FloorQuery floorQuery, FloorSearch floorSearch)	Gets the search results matching the given search.
FloorSearch	getFloorSearch()	Gets a floor search.
FloorSearchOrder	getFloorSearchOrder()	Gets a floor search order.

Methods inherited from interface Closeable

close

Methods inherited from interface FloorQuerySession

canSearchFloors, getCampus, getCampusId, getFloorQuery, getFloorsByQuery, useFederatedCampusView, useIsolatedCampusView

Modifier and Type	Method	Description
boolean	canSearchFloors()	Tests if this user can perform Floor searches.
Campus	getCampus()	Gets the Campus associated with this session.
Id	getCampusId()	Gets the Campus Id associated with this session.
FloorQuery	getFloorQuery()	Gets a floor query.
FloorList	getFloorsByQuery(FloorQuery floorQuery)	Gets a list of Floors matching the given floor query.
void	useFederatedCampusView()	Federates the view for methods in this session.
void	useIsolatedCampusView()	Isolates the view for methods in this session.

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

getFloorSearch

FloorSearch getFloorSearch()

Gets a floor search.

Returns:

the floor search

Compliance:

mandatory - This method must be implemented.

getFloorSearchOrder

FloorSearchOrder getFloorSearchOrder()

Gets a floor search order. The FloorSearchOrder is supplied to a FloorSearch to specify the ordering of results.

Returns:

the floor search order

Compliance:

mandatory - This method must be implemented.

getFloorsBySearch

FloorSearchResults getFloorsBySearch(FloorQuery floorQuery,
 FloorSearch floorSearch)
                              throws OperationFailedException,
PermissionDeniedException

Gets the search results matching the given search.

Parameters:

floorQuery - the floor query

floorSearch - the floor search

Returns:

the floor search results

Throws:

NullArgumentException - floorQuery or floorSearch is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - floorQuery or floorSearch is not of this service

Compliance:

mandatory - This method must be implemented.

getFloorQueryFromInspector

FloorQuery getFloorQueryFromInspector(FloorQueryInspector floorQueryInspector)

Gets an entry query from an inspector. The inspector is available from an FloorSearchResults.

Parameters:

floorQueryInspector - a query inspector

Returns:

the entry query

Throws:

NullArgumentException - floorQueryInspector is null

UnsupportedException - floorQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.