Interface | osid.room.Floor | ||
---|---|---|---|
Implements | osid.OsidObject | ||
osid.Temporal | |||
osid.Subjugateable | |||
Description |
A | ||
Method | getBuildingId | ||
Description |
Gets the | ||
Return | osid.id.Id | the building Id | |
Compliance | mandatory | This method must be implemented. | |
Method | getBuilding | ||
Description |
Gets the building. | ||
Return | osid.room.Building | the building | |
Errors | OPERATION_FAILED | unable to complete request | |
Compliance | mandatory | This method must be implemented. | |
Method | getNumber | ||
Description |
Gets the floor number. | ||
Return | string | the floor number | |
Compliance | mandatory | This method must be implemented. | |
Method | hasArea | ||
Description |
Tests if an area is available. | ||
Return | boolean | true if an area is available, false otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getGrossArea | ||
Description |
Gets the gross square footage of this floor. | ||
Return | decimal | the gross area | |
Errors | ILLEGAL_STATE | hasArea() is false | |
Compliance | mandatory | This method must be implemented. | |
Method | getFloorRecord | ||
Description |
Gets the floor record corresponding to the given | ||
Parameters | osid.type.Type | floorRecordType | the type of floor record to retrieve |
Return | osid.room.records.FloorRecord | the floor record | |
Errors | NULL_ARGUMENT | floorRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
UNSUPPORTED | hasRecordType(floorRecordType) is false | ||
Compliance | mandatory | This method must be implemented. |