Interface | osid.room.FloorQuery | ||
---|---|---|---|
Implements | osid.OsidObjectQuery | ||
osid.OsidTemporalQuery | |||
osid.OsidSubjugateableQuery | |||
Description |
This is the query for searching for floors. Each method
specifies an | ||
Method | matchBuildingId | ||
Description |
Sets the building | ||
Parameters | osid.id.Id | buildingId | a building Id |
boolean | match | true for a positive match, false for a
negative match | |
Errors | NULL_ARGUMENT | buildingId is null | |
Compliance | mandatory | This method must be implemented. | |
Method | clearBuildingIdTerms | ||
Description |
Clears the building | ||
Compliance | mandatory | This method must be implemented. | |
Method | supportsBuildingQuery | ||
Description |
Tests if a | ||
Return | boolean | true if a building query is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getBuildingQuery | ||
Description |
Gets the query for a building query. Multiple
retrievals produce a nested | ||
Return | osid.room.BuildingQuery | the building query | |
Errors | UNIMPLEMENTED | supportsBuildingQuery() is false | |
Compliance | optional | This method must be implemented if supportsBuildingQuery()
is true. | |
Method | clearBuildingTerms | ||
Description |
Clears the building terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchNumber | ||
Description |
Sets a floor number. | ||
Parameters | string | number | a number |
osid.type.Type | stringMatchType | a string match type | |
boolean | match | true for a positive match, false for a
negative match | |
Errors | INVALID_ARGUMENT | number is not of stringMatchType | |
NULL_ARGUMENT | number is null | ||
UNSUPPORTED | supportsStringMatchType(stringMatchType) is false
| ||
Compliance | mandatory | This method must be implemented. | |
Method | matchAnyNumber | ||
Description |
Matches any floor number. | ||
Parameters | boolean | match | true to match floors with any number, false
to match floors with no number |
Compliance | mandatory | This method must be implemented. | |
Method | clearNumberTerms | ||
Description |
Clears the number terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchGrossArea | ||
Description |
Matches an area within the given range inclusive. | ||
Parameters | decimal | low | start of range |
decimal | high | end of range | |
boolean | match | true for a positive match, false for a
negative match | |
Errors | INVALID_ARGUMENT | low is greater than high | |
Compliance | mandatory | This method must be implemented. | |
Method | matchAnyGrossArea | ||
Description |
Matches any area. | ||
Parameters | boolean | match | true to match floors with any area, false to
match floors with no area assigned |
Compliance | mandatory | This method must be implemented. | |
Method | clearGrossAreaTerms | ||
Description |
Clears the area terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchRoomId | ||
Description |
Sets the room | ||
Parameters | osid.id.Id | roomId | a room Id |
boolean | match | true for a positive match, false for a
negative match | |
Errors | NULL_ARGUMENT | roomId is null | |
Compliance | mandatory | This method must be implemented. | |
Method | clearRoomIdTerms | ||
Description |
Clears the room | ||
Compliance | mandatory | This method must be implemented. | |
Method | supportsRoomQuery | ||
Description |
Tests if a room query is available. | ||
Return | boolean | true if a room query is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getRoomQuery | ||
Description |
Gets the query for a floor. | ||
Return | osid.room.RoomQuery | the room query | |
Errors | UNIMPLEMENTED | supportsRoomQuery() is false | |
Compliance | optional | This method must be implemented if supportsRoomQuery() is
true. | |
Method | matchAnyRoom | ||
Description |
Matches floors. with any room. | ||
Parameters | boolean | match | true to match floors with any room, false to
match floors with no rooms |
Compliance | mandatory | This method must be implemented. | |
Method | clearRoomTerms | ||
Description |
Clears the room terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchCampusId | ||
Description |
Sets the floor | ||
Parameters | osid.id.Id | campusId | a campus Id |
boolean | match | true for a positive match, false for a
negative match | |
Errors | NULL_ARGUMENT | campusId is null | |
Compliance | mandatory | This method must be implemented. | |
Method | clearCampusIdTerms | ||
Description |
Clears the campus | ||
Compliance | mandatory | This method must be implemented. | |
Method | supportsCampusQuery | ||
Description |
Tests if a | ||
Return | boolean | true if a campus query is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getCampusQuery | ||
Description |
Gets the query for a campus query. Multiple retrievals
produce a nested | ||
Return | osid.room.CampusQuery | the campus query | |
Errors | UNIMPLEMENTED | supportsCampusQuery() is false | |
Compliance | optional | This method must be implemented if supportsCampusQuery() is
true. | |
Method | clearCampusTerms | ||
Description |
Clears the campus terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | getFloorQueryRecord | ||
Description |
Gets the floor query record corresponding to the given
| ||
Parameters | osid.type.Type | floorRecordType | a floor record type |
Return | osid.room.records.FloorQueryRecord | the floor query record | |
Errors | NULL_ARGUMENT | floorRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
UNSUPPORTED | hasRecordType(floorRecordType) is false | ||
Compliance | mandatory | This method must be implemented. |