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 Details

    • 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

      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

      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.