OSID Logo
OSID Specifications
room package
Version 3.0.0
Release Candidate Preview
Interfaceosid.room.Floor
Implementsosid.OsidObject
osid.Temporal
osid.Subjugateable
Description

A Floor represents a collection of rooms with a Building.

MethodgetBuildingId
Description

Gets the Id of the building.

Returnosid.id.Idthe building Id
CompliancemandatoryThis method must be implemented.
MethodgetBuilding
Description

Gets the building.

Returnosid.room.Buildingthe building
ErrorsOPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodgetNumber
Description

Gets the floor number.

Returnstringthe floor number
CompliancemandatoryThis method must be implemented.
MethodhasArea
Description

Tests if an area is available.

Returnboolean true if an area is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetGrossArea
Description

Gets the gross square footage of this floor.

Returndecimalthe gross area
ErrorsILLEGAL_STATE hasArea() is false
CompliancemandatoryThis method must be implemented.
MethodgetFloorRecord
Description

Gets the floor record corresponding to the given Floor record Type. This method is used to retrieve an object implementing the requested record. The floorRecordType may be the Type returned in getRecordTypes() or any of its parents in a Type hierarchy where hasRecordType(floorRecordType) is true .

Parametersosid.type.TypefloorRecordTypethe type of floor record to retrieve
Returnosid.room.records.FloorRecordthe floor record
ErrorsNULL_ARGUMENT floorRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(floorRecordType) is false
CompliancemandatoryThis method must be implemented.