Interface FloorSearchResults

All Superinterfaces:

Browsable, Extensible, OsidResult, OsidSearchResults

public interface FloorSearchResults
extends OsidSearchResults

This interface provides a means to capture results of a search.

Method Summary

Modifier and Type	Method	Description
FloorQueryInspector	getFloorQueryInspector()	Gets the inspector for the query to examine the terns used in the search.
FloorList	getFloors()	Gets the floor list resulting from a search.
FloorSearchResultsRecord	getFloorSearchResultsRecord(Type floorSearchRecordType)	Gets the floor search results record corresponding to the given floor search record Type.

Methods inherited from interface Browsable

getProperties, getPropertiesByRecordType

Modifier and Type	Method	Description
PropertyList	getProperties()	Gets a list of properties.
PropertyList	getPropertiesByRecordType(Type recordType)	Gets a list of properties corresponding to the specified record type.

Methods inherited from interface Extensible

getRecordTypes, hasRecordType

Modifier and Type	Method	Description
TypeList	getRecordTypes()	Gets the record types available in this object.
boolean	hasRecordType(Type recordType)	Tests if this object supports the given record Type .

Methods inherited from interface OsidSearchResults

getResultSize

Modifier and Type	Method	Description
long	getResultSize()	Returns the size of a result set from a search query.

Method Details

getFloors

FloorList getFloors()

Gets the floor list resulting from a search.

Returns:

the floor list

Throws:

IllegalStateException - list has already been retrieved

Compliance:

mandatory - This method must be implemented.

getFloorQueryInspector

FloorQueryInspector getFloorQueryInspector()

Gets the inspector for the query to examine the terns used in the search.

Returns:

the query inspector

Compliance:

mandatory - This method must be implemented.

getFloorSearchResultsRecord

FloorSearchResultsRecord getFloorSearchResultsRecord(Type floorSearchRecordType)
                                              throws OperationFailedException

Gets the floor search results record corresponding to the given floor search record Type. This method is used to retrieve an object implementing the requested record.

Parameters:

floorSearchRecordType - a floor search record type

Returns:

the floor search results record

Throws:

NullArgumentException - FloorSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(floorSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.