OSID Logo
OSID Specifications
room package
Version 3.0.0
Release Candidate Preview
Interfaceosid.room.RoomQuery
Implementsosid.OsidObjectQuery
osid.OsidTemporalQuery
osid.OsidSubjugateableQuery
Description

This is the query for searching rooms. Each method specifies an AND term while multiple invocations of the same method produce a nested OR.

MethodmatchBuildingId
Description

Sets the building Id for this query to match rooms assigned to buildings.

Parametersosid.id.IdbuildingIda building Id
booleanmatch true for a positive match, false for a negative match
ErrorsNULL_ARGUMENT buildingId is null
CompliancemandatoryThis method must be implemented.
MethodclearBuildingIdTerms
Description

Clears the building Id terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsBuildingQuery
Description

Tests if a BuildingQuery is available.

Returnboolean true if a building query is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetBuildingQuery
Description

Gets the query for a building query. Multiple retrievals produce a nested OR term.

Returnosid.room.BuildingQuerythe building query
ErrorsUNIMPLEMENTED supportsBuildingQuery() is false
ComplianceoptionalThis method must be implemented if supportsBuildingQuery() is true.
MethodclearBuildingTerms
Description

Clears the building terms.

CompliancemandatoryThis method must be implemented.
MethodmatchFloorId
Description

Sets the floor Id for this query to match rooms assigned to campuses.

Parametersosid.id.IdfloorIda floor Id
booleanmatch true for a positive match, false for a negative match
ErrorsNULL_ARGUMENT floorId is null
CompliancemandatoryThis method must be implemented.
MethodclearFloorIdTerms
Description

Clears the floor Id terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsFloorQuery
Description

Tests if a floor query is available.

Returnboolean true if a room query is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetFloorQuery
Description

Gets the query for a floor.

Returnosid.room.FloorQuerythe floor query
ErrorsUNIMPLEMENTED supportsFloorQuery() is false
ComplianceoptionalThis method must be implemented if supportsFloorQuery() is true.
MethodclearFloorTerms
Description

Clears the floor terms.

CompliancemandatoryThis method must be implemented.
MethodmatchEnclosingRoomId
Description

Sets an enclosing room Id.

Parametersosid.id.IdroomIdan enclosing room Id
booleanmatch true for a positive match, false for a negative match
ErrorsNULL_ARGUMENT roomId is null
CompliancemandatoryThis method must be implemented.
MethodclearEnclosingRoomIdTerms
Description

Clears the enclosing room Id terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsEnclosingRoomQuery
Description

Tests if an EnclosingRoomQuery is available.

Returnboolean true if an enclosing room query is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetEnclosingRoomQuery
Description

Gets the query for an enclosing room query. Multiple retrievals produce a nested OR term.

Returnosid.room.RoomQuerythe room query
ErrorsUNIMPLEMENTED supportsEnclosingRoomQuery() is false
ComplianceoptionalThis method must be implemented if supportsEnclosingRoomQuery() is true.
MethodmatchAnyEnclosingRoom
Description

Matches any enclosing room.

Parametersbooleanmatch true for a to match any room enclosed in another room,, false otherwise
CompliancemandatoryThis method must be implemented.
MethodclearEnclosingRoomTerms
Description

Clears the enclosing room terms.

CompliancemandatoryThis method must be implemented.
MethodmatchSubdivisionId
Description

Sets a subdivision room Id.

Parametersosid.id.IdroomIda subdivision room Id
booleanmatch true for a positive match, false for a negative match
ErrorsNULL_ARGUMENT roomId is null
CompliancemandatoryThis method must be implemented.
MethodclearSubdivisionIdTerms
Description

Clears the subdivision room Id terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsSubdivisionQuery
Description

Tests if a RoomQuery is available.

Returnboolean true if a subdivision room query is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetSubdivisionQuery
Description

Gets the query for a subdivision room query. Multiple retrievals produce a nested OR term.

Returnosid.room.RoomQuerythe room query
ErrorsUNIMPLEMENTED supportsSubdivisionRoomQuery() is false
ComplianceoptionalThis method must be implemented if supportsSubdivisionRoomQuery() is true.
MethodmatchAnySubdivision
Description

Matches any subdivision room.

Parametersbooleanmatch true for a to match any room containg another room,, false otherwise
CompliancemandatoryThis method must be implemented.
MethodclearSubdivisionTerms
Description

Clears the subdivision room terms.

CompliancemandatoryThis method must be implemented.
MethodmatchDesignatedName
Description

Sets a name.

Parametersstringnamean official name
osid.type.TypestringMatchTypea string match type
booleanmatch true for a positive match, false for a negative match
ErrorsINVALID_ARGUMENT name is not of stringMatchType
NULL_ARGUMENT name is null
UNSUPPORTED supportsStringMatchType(stringMatchType) is false
CompliancemandatoryThis method must be implemented.
MethodmatchAnyDesignatedName
Description

Matches any designated name.

Parametersbooleanmatch true to match rooms with any designated name, false to match rooms with no designated name
CompliancemandatoryThis method must be implemented.
MethodclearDesignatedNameTerms
Description

Clears the designated name terms.

CompliancemandatoryThis method must be implemented.
MethodmatchRoomNumber
Description

Sets a room number.

Parametersstringnumbera number
osid.type.TypestringMatchTypea string match type
booleanmatch true for a positive match, false for a negative match
ErrorsINVALID_ARGUMENT number is not of stringMatchType
NULL_ARGUMENT number is null
UNSUPPORTED supportsStringMatchType(stringMatchType) is false
CompliancemandatoryThis method must be implemented.
MethodmatchAnyRoomNumber
Description

Matches any room number.

Parametersbooleanmatch true to match rooms with any number, false to match rooms with no number
CompliancemandatoryThis method must be implemented.
MethodclearRoomNumberTerms
Description

Clears the room number terms.

CompliancemandatoryThis method must be implemented.
MethodmatchCode
Description

Sets a room code.

Parametersstringcodea room code
osid.type.TypestringMatchTypea string match type
booleanmatch true for a positive match, false for a negative match
ErrorsINVALID_ARGUMENT code is not of stringMatchType
NULL_ARGUMENT code is null
UNSUPPORTED supportsStringMatchType(stringMatchType) is false
CompliancemandatoryThis method must be implemented.
MethodmatchAnyCode
Description

Matches any room code.

Parametersbooleanmatch true to match rooms with any code, false to match rooms with no code
CompliancemandatoryThis method must be implemented.
MethodclearCodeTerms
Description

Clears the code terms.

CompliancemandatoryThis method must be implemented.
MethodmatchArea
Description

Matches an area within the given range inclusive.

Parametersdecimallowstart of range
decimalhighend of range
booleanmatch true for a positive match, false for a negative match
ErrorsINVALID_ARGUMENT low is greater than high
NULL_ARGUMENT low or high is null
CompliancemandatoryThis method must be implemented.
MethodmatchAnyArea
Description

Matches any area.

Parametersbooleanmatch true to match rooms with any area, false to match rooms with no area assigned
CompliancemandatoryThis method must be implemented.
MethodclearAreaTerms
Description

Clears the area terms.

CompliancemandatoryThis method must be implemented.
MethodmatchOccupancyLimit
Description

Matches an occupancy limit within the given range inclusive.

Parameterscardinallowstart of range
cardinalhighend of range
booleanmatch true for a positive match, false for a negative match
ErrorsINVALID_ARGUMENT low is greater than high
CompliancemandatoryThis method must be implemented.
MethodmatchAnyOccupancyLimit
Description

Matches rooms with any occupancy limit.

Parametersbooleanmatch true to match rooms with any occupancy limit, false to match rooms with no limit assigned
CompliancemandatoryThis method must be implemented.
MethodclearOccupancyLimitTerms
Description

Clears the occupancy limit terms.

CompliancemandatoryThis method must be implemented.
MethodmatchResourceId
Description

Sets the room Id for this query to match resources assigned to rooms.

Parametersosid.id.IdroomIda room Id
booleanmatch true for a positive match, false for a negative match
ErrorsNULL_ARGUMENT roomId is null
CompliancemandatoryThis method must be implemented.
MethodclearResourceIdTerms
Description

Clears the resource Id terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsResourceQuery
Description

Tests if a resource query is available.

Returnboolean true if a resource query is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetResourceQuery
Description

Gets the query for a room resource.

Returnosid.resource.ResourceQuerythe resource query
ErrorsUNIMPLEMENTED supportsResourceQuery() is false
ComplianceoptionalThis method must be implemented if supportsResourceQuery() is true.
MethodmatchAnyResource
Description

Matches rooms with any resource.

Parametersbooleanmatch true to match rooms with any resource, false to match rooms with no resources
CompliancemandatoryThis method must be implemented.
MethodclearResourceTerms
Description

Clears the resource terms.

CompliancemandatoryThis method must be implemented.
MethodmatchCampusId
Description

Sets the building Id for this query to match rooms assigned to campuses.

Parametersosid.id.IdcampusIda campus Id
booleanmatch true for a positive match, false for a negative match
ErrorsNULL_ARGUMENT campusId is null
CompliancemandatoryThis method must be implemented.
MethodclearCampusIdTerms
Description

Clears the campus Id terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsCampusQuery
Description

Tests if a CampusQuery is available.

Returnboolean true if a campus query is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetCampusQuery
Description

Gets the query for a campus query. Multiple retrievals produce a nested OR term.

Returnosid.room.CampusQuerythe campus query
ErrorsUNIMPLEMENTED supportsCampusQuery() is false
ComplianceoptionalThis method must be implemented if supportsCampusQuery() is true.
MethodclearCampusTerms
Description

Clears the campus terms.

CompliancemandatoryThis method must be implemented.
MethodgetRoomQueryRecord
Description

Gets the room query record corresponding to the given Room record Type. Multiple record retrievals produce a nested OR term.

Parametersosid.type.TyperoomRecordTypea room record type
Returnosid.room.records.RoomQueryRecordthe room query record
ErrorsNULL_ARGUMENT roomRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(roomRecordType) is false
CompliancemandatoryThis method must be implemented.