Interface Renovation

All Superinterfaces:
Browsable, Extensible, Identifiable, OsidObject, Temporal
public interface Renovation extends OsidObject, Temporal

A Renovation represents a construction project within a building.

  • Method Details

    • getRoomIds

      IdList getRoomIds()
      Gets the Id of the affected rooms.
      Returns:
      the room Id
      Compliance:
      mandatory - This method must be implemented.

    • getRooms

      RoomList getRooms() throws OperationFailedException
      Gets the affected rooms.
      Returns:
      the rooms
      Throws:
      OperationFailedException - unable to complete request
      Compliance:
      mandatory - This method must be implemented.

    • hasCost

      boolean hasCost()
      Tests if this renovation has a cost.
      Returns:
      true if a cost is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • getCost

      Currency getCost()
      Gets the cost for this renovation.
      Returns:
      the cost
      Throws:
      IllegalStateException - hasCost() is false
      Compliance:
      mandatory - This method must be implemented.

    • getRenovationRecord

      RenovationRecord getRenovationRecord(Type renovationRecordType) throws OperationFailedException
      Gets the renovation record corresponding to the given Renovation record Type. This method is used to retrieve an object implementing the requested record. The renovationRecordType may be the Type returned in getRecordTypes() or any of its parents in a Type hierarchy where hasRecordType(renovationRecordType) is true.
      Parameters:
      renovationRecordType - the type of renovation record to retrieve
      Returns:
      the renovation record
      Throws:
      NullArgumentException - renovationRecordType is null
      OperationFailedException - unable to complete request
      UnsupportedException - hasRecordType(renovationRecordType) is false
      Compliance:
      mandatory - This method must be implemented.