org.osid.room

Interface FloorSearchSession

All Superinterfaces:

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

public interface FloorSearchSession
extends FloorQuerySession

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

Methods

Modifier and Type	Method and 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 org.osid.room.FloorQuerySession

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

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

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.