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

This is the query for searching for floors. 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 floors 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.
MethodmatchNumber
Description

Sets a floor 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.
MethodmatchAnyNumber
Description

Matches any floor number.

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

Clears the number terms.

CompliancemandatoryThis method must be implemented.
MethodmatchGrossArea
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
CompliancemandatoryThis method must be implemented.
MethodmatchAnyGrossArea
Description

Matches any area.

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

Clears the area terms.

CompliancemandatoryThis method must be implemented.
MethodmatchRoomId
Description

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

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.
MethodclearRoomIdTerms
Description

Clears the room Id terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsRoomQuery
Description

Tests if a room query is available.

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

Gets the query for a floor.

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

Matches floors. with any room.

Parametersbooleanmatch true to match floors with any room, false to match floors with no rooms
CompliancemandatoryThis method must be implemented.
MethodclearRoomTerms
Description

Clears the room terms.

CompliancemandatoryThis method must be implemented.
MethodmatchCampusId
Description

Sets the floor 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.
MethodgetFloorQueryRecord
Description

Gets the floor query record corresponding to the given Floor record Type. Multiple record retrievals produce a nested boolean OR term.

Parametersosid.type.TypefloorRecordTypea floor record type
Returnosid.room.records.FloorQueryRecordthe floor query record
ErrorsNULL_ARGUMENT floorRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(floorRecordType) is false
CompliancemandatoryThis method must be implemented.