Interface | osid.room.RoomQuery | ||
---|---|---|---|
Implements | osid.OsidObjectQuery | ||
osid.OsidTemporalQuery | |||
osid.OsidSubjugateableQuery | |||
Description |
This is the query for searching rooms. 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 | matchFloorId | ||
Description |
Sets the floor | ||
Parameters | osid.id.Id | floorId | a floor Id |
boolean | match | true for a positive match, false for a
negative match | |
Errors | NULL_ARGUMENT | floorId is null | |
Compliance | mandatory | This method must be implemented. | |
Method | clearFloorIdTerms | ||
Description |
Clears the floor | ||
Compliance | mandatory | This method must be implemented. | |
Method | supportsFloorQuery | ||
Description |
Tests if a floor query is available. | ||
Return | boolean | true if a room query is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getFloorQuery | ||
Description |
Gets the query for a floor. | ||
Return | osid.room.FloorQuery | the floor query | |
Errors | UNIMPLEMENTED | supportsFloorQuery() is false | |
Compliance | optional | This method must be implemented if supportsFloorQuery() is
true. | |
Method | clearFloorTerms | ||
Description |
Clears the floor terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchEnclosingRoomId | ||
Description |
Sets an enclosing room | ||
Parameters | osid.id.Id | roomId | an enclosing 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 | clearEnclosingRoomIdTerms | ||
Description |
Clears the enclosing room | ||
Compliance | mandatory | This method must be implemented. | |
Method | supportsEnclosingRoomQuery | ||
Description |
Tests if an | ||
Return | boolean | true if an enclosing room query is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getEnclosingRoomQuery | ||
Description |
Gets the query for an enclosing room query. Multiple
retrievals produce a nested | ||
Return | osid.room.RoomQuery | the room query | |
Errors | UNIMPLEMENTED | supportsEnclosingRoomQuery() is false | |
Compliance | optional | This method must be implemented if supportsEnclosingRoomQuery()
is true. | |
Method | matchAnyEnclosingRoom | ||
Description |
Matches any enclosing room. | ||
Parameters | boolean | match | true for a to match any room enclosed in another room,,
false otherwise |
Compliance | mandatory | This method must be implemented. | |
Method | clearEnclosingRoomTerms | ||
Description |
Clears the enclosing room terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchSubdivisionId | ||
Description |
Sets a subdivision room | ||
Parameters | osid.id.Id | roomId | a subdivision 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 | clearSubdivisionIdTerms | ||
Description |
Clears the subdivision room | ||
Compliance | mandatory | This method must be implemented. | |
Method | supportsSubdivisionQuery | ||
Description |
Tests if a | ||
Return | boolean | true if a subdivision room query is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getSubdivisionQuery | ||
Description |
Gets the query for a subdivision room query. Multiple
retrievals produce a nested | ||
Return | osid.room.RoomQuery | the room query | |
Errors | UNIMPLEMENTED | supportsSubdivisionRoomQuery() is false | |
Compliance | optional | This method must be implemented if supportsSubdivisionRoomQuery()
is true. | |
Method | matchAnySubdivision | ||
Description |
Matches any subdivision room. | ||
Parameters | boolean | match | true for a to match any room containg another room,,
false otherwise |
Compliance | mandatory | This method must be implemented. | |
Method | clearSubdivisionTerms | ||
Description |
Clears the subdivision room terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchDesignatedName | ||
Description |
Sets a name. | ||
Parameters | string | name | an official name |
osid.type.Type | stringMatchType | a string match type | |
boolean | match | true for a positive match, false for a
negative match | |
Errors | INVALID_ARGUMENT | name is not of stringMatchType | |
NULL_ARGUMENT | name is null | ||
UNSUPPORTED | supportsStringMatchType(stringMatchType) is false
| ||
Compliance | mandatory | This method must be implemented. | |
Method | matchAnyDesignatedName | ||
Description |
Matches any designated name. | ||
Parameters | boolean | match | true to match rooms with any designated name, false
to match rooms with no designated name |
Compliance | mandatory | This method must be implemented. | |
Method | clearDesignatedNameTerms | ||
Description |
Clears the designated name terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchRoomNumber | ||
Description |
Sets a room 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 | matchAnyRoomNumber | ||
Description |
Matches any room number. | ||
Parameters | boolean | match | true to match rooms with any number, false to
match rooms with no number |
Compliance | mandatory | This method must be implemented. | |
Method | clearRoomNumberTerms | ||
Description |
Clears the room number terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchCode | ||
Description |
Sets a room code. | ||
Parameters | string | code | a room code |
osid.type.Type | stringMatchType | a string match type | |
boolean | match | true for a positive match, false for a
negative match | |
Errors | INVALID_ARGUMENT | code is not of stringMatchType | |
NULL_ARGUMENT | code is null | ||
UNSUPPORTED | supportsStringMatchType(stringMatchType) is false
| ||
Compliance | mandatory | This method must be implemented. | |
Method | matchAnyCode | ||
Description |
Matches any room code. | ||
Parameters | boolean | match | true to match rooms with any code, false to
match rooms with no code |
Compliance | mandatory | This method must be implemented. | |
Method | clearCodeTerms | ||
Description |
Clears the code terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchArea | ||
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 | |
NULL_ARGUMENT | low or high is null | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchAnyArea | ||
Description |
Matches any area. | ||
Parameters | boolean | match | true to match rooms with any area, false to
match rooms with no area assigned |
Compliance | mandatory | This method must be implemented. | |
Method | clearAreaTerms | ||
Description |
Clears the area terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchOccupancyLimit | ||
Description |
Matches an occupancy limit within the given range inclusive. | ||
Parameters | cardinal | low | start of range |
cardinal | 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 | matchAnyOccupancyLimit | ||
Description |
Matches rooms with any occupancy limit. | ||
Parameters | boolean | match | true to match rooms with any occupancy limit, false
to match rooms with no limit assigned |
Compliance | mandatory | This method must be implemented. | |
Method | clearOccupancyLimitTerms | ||
Description |
Clears the occupancy limit terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchResourceId | ||
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 | clearResourceIdTerms | ||
Description |
Clears the resource | ||
Compliance | mandatory | This method must be implemented. | |
Method | supportsResourceQuery | ||
Description |
Tests if a resource query is available. | ||
Return | boolean | true if a resource query is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getResourceQuery | ||
Description |
Gets the query for a room resource. | ||
Return | osid.resource.ResourceQuery | the resource query | |
Errors | UNIMPLEMENTED | supportsResourceQuery() is false | |
Compliance | optional | This method must be implemented if supportsResourceQuery()
is true. | |
Method | matchAnyResource | ||
Description |
Matches rooms with any resource. | ||
Parameters | boolean | match | true to match rooms with any resource, false
to match rooms with no resources |
Compliance | mandatory | This method must be implemented. | |
Method | clearResourceTerms | ||
Description |
Clears the resource terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchCampusId | ||
Description |
Sets the building | ||
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 | getRoomQueryRecord | ||
Description |
Gets the room query record corresponding to the given
| ||
Parameters | osid.type.Type | roomRecordType | a room record type |
Return | osid.room.records.RoomQueryRecord | the room query record | |
Errors | NULL_ARGUMENT | roomRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
UNSUPPORTED | hasRecordType(roomRecordType) is false | ||
Compliance | mandatory | This method must be implemented. |