OSID Logo
OSID Specifications
room package
Version 3.0.0
Release Candidate Preview
Interfaceosid.room.FloorSearchSession
Implementsosid.room.FloorQuerySession
Description

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.

MethodgetFloorSearch
Description

Gets a floor search.

Returnosid.room.FloorSearchthe floor search
CompliancemandatoryThis method must be implemented.
MethodgetFloorSearchOrder
Description

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

Returnosid.room.FloorSearchOrderthe floor search order
CompliancemandatoryThis method must be implemented.
MethodgetFloorsBySearch
Description

Gets the search results matching the given search.

Parametersosid.room.FloorQueryfloorQuerythe floor query
osid.room.FloorSearchfloorSearchthe floor search
Returnosid.room.FloorSearchResultsthe floor search results
ErrorsNULL_ARGUMENT floorQuery or floorSearch is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED floorQuery or floorSearch is not of this service
CompliancemandatoryThis method must be implemented.
MethodgetFloorQueryFromInspector
Description

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

Parametersosid.room.FloorQueryInspectorfloorQueryInspectora query inspector
Returnosid.room.FloorQuerythe entry query
ErrorsNULL_ARGUMENT floorQueryInspector is null
UNSUPPORTED floorQueryInspector is not of this service
CompliancemandatoryThis method must be implemented.