org.osid.room

Interface Floor

All Superinterfaces:

Browsable, Extensible, Identifiable, OsidObject, Subjugateable, Temporal

public interface Floor
extends OsidObject, Temporal, Subjugateable

A Floor represents a collection of rooms with a Building.

Method Summary

Methods

Modifier and Type	Method and Description
Building	getBuilding() Gets the building.
Id	getBuildingId() Gets the Id of the building.
FloorRecord	getFloorRecord(Type floorRecordType) Gets the floor record corresponding to the given Floor record Type.
java.math.BigDecimal	getGrossArea() Gets the gross square footage of this floor.
java.lang.String	getNumber() Gets the floor number.
boolean	hasArea() Tests if an area is available.

Methods inherited from interface org.osid.OsidObject

getDescription, getDisplayName, getGenusType, isOfGenusType

Methods inherited from interface org.osid.Identifiable

getId, isCurrent

Methods inherited from interface org.osid.Extensible

getRecordTypes, hasRecordType

Methods inherited from interface org.osid.Browsable

getProperties, getPropertiesByRecordType

Methods inherited from interface org.osid.Temporal

getEndDate, getStartDate, isEffective

Method Detail

getBuildingId

Id getBuildingId()

Gets the Id of the building.

Returns:

the building Id

Compliance:

mandatory - This method must be implemented.

getBuilding

Building getBuilding()
                     throws OperationFailedException

Gets the building.

Returns:

the building

Throws:

OperationFailedException - unable to complete request

Compliance:

mandatory - This method must be implemented.

getNumber

java.lang.String getNumber()

Gets the floor number.

Returns:

the floor number

Compliance:

mandatory - This method must be implemented.

hasArea

boolean hasArea()

Tests if an area is available.

Returns:

true if an area is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getGrossArea

java.math.BigDecimal getGrossArea()

Gets the gross square footage of this floor.

Returns:

the gross area

Throws:

IllegalStateException - hasArea() is false

Compliance:

mandatory - This method must be implemented.

getFloorRecord

FloorRecord getFloorRecord(Type floorRecordType)
                           throws OperationFailedException

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 .

Parameters:

floorRecordType - the type of floor record to retrieve

Returns:

the floor record

Throws:

NullArgumentException - floorRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(floorRecordType) is false

Compliance:

mandatory - This method must be implemented.