Interface | osid.room.FloorSearch | ||
---|---|---|---|
Implements | osid.OsidSearch | ||
Description |
The search interface for governing floor searches. | ||
Method | searchAmongFloors | ||
Description |
Execute this search among the given list of floors. | ||
Parameters | osid.id.IdList | floorIds | list of floors |
Errors | NULL_ARGUMENT | floorIds is null | |
Compliance | mandatory | This method must be implemented. | |
Method | orderFloorResults | ||
Description |
Specify an ordering to the search results. | ||
Parameters | osid.room.FloorSearchOrder | floorSearchOrder | floor search order |
Errors | NULL_ARGUMENT | floorSearchOrder is null | |
UNSUPPORTED | floorSearchOrder is not of this service | ||
Compliance | mandatory | This method must be implemented. | |
Method | getFloorSearchRecord | ||
Description |
Gets the dis[atch search record corresponding to the
given floor search record | ||
Parameters | osid.type.Type | floorSearchRecordType | a floor search record type |
Return | osid.room.records.FloorSearchRecord | the floor search record | |
Errors | NULL_ARGUMENT | floorSearchRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
UNSUPPORTED | hasRecordType(floorSearchRecordType) is false | ||
Compliance | mandatory | This method must be implemented. |