public interface FloorSearch extends OsidSearch
The search interface for governing floor searches.
Modifier and Type | Method and Description |
---|---|
FloorSearchRecord |
getFloorSearchRecord(Type floorSearchRecordType)
Gets the dis[atch search record corresponding to the given floor
search record
Type. |
void |
orderFloorResults(FloorSearchOrder floorSearchOrder)
Specify an ordering to the search results.
|
void |
searchAmongFloors(IdList floorIds)
Execute this search among the given list of floors.
|
limitResultSet
getRecordTypes, hasRecordType
void searchAmongFloors(IdList floorIds)
floorIds
- list of floorsNullArgumentException
- floorIds
is
null
mandatory
- This method must be implemented. void orderFloorResults(FloorSearchOrder floorSearchOrder)
floorSearchOrder
- floor search orderNullArgumentException
- floorSearchOrder
is null
UnsupportedException
- floorSearchOrder
is not of this servicemandatory
- This method must be implemented. FloorSearchRecord getFloorSearchRecord(Type floorSearchRecordType) throws OperationFailedException
Type.
This method is used to retrieve an
object implementing the requested record.floorSearchRecordType
- a floor search record typeNullArgumentException
- floorSearchRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(floorSearchRecordType)
is false
mandatory
- This method must be implemented.