OSID Logo
OSID Specifications
room package
Version 3.1.0
Interfaceosid.room.Floor
Implementsosid.OsidObject
osid.Temporal
osid.Subjugateable
Used Byosid.room.FloorAdminSession
osid.room.FloorList
osid.room.FloorLookupSession
osid.room.Room
Description

A Floor represents a collection of rooms with a Building.

MethodgetBuildingId
Description

Gets the Id of the building.

Returnosid.id.Id the building Id
Compliancemandatory This method must be implemented.
MethodgetBuilding
Description

Gets the building.

Returnosid.room.Building the building
ErrorsOPERATION_FAILED unable to complete request
Compliancemandatory This method must be implemented.
MethodgetNumber
Description

Gets the floor number.

Returnstring the floor number
Compliancemandatory This method must be implemented.
MethodhasArea
Description

Tests if an area is available.

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

Gets the gross square footage of this floor.

Returndecimal the gross area
ErrorsILLEGAL_STATE hasArea() is false
Compliancemandatory This 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.TypefloorRecordType the type of floor record to retrieve
Returnosid.room.records.FloorRecord the floor record
ErrorsNULL_ARGUMENT floorRecordType is null
OPERATION_FAILED unable to complete request
UNSUPPORTED hasRecordType(floorRecordType) is false
Compliancemandatory This method must be implemented.