Interface Room

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

A Room .

  • 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.

    • getFloorId

      Id getFloorId()
      Gets the floor Id .
      Returns:
      the floor Id
      Compliance:
      mandatory - This method must be implemented.

    • getFloor

      Floor getFloor() throws OperationFailedException
      Gets the floor.
      Returns:
      the floor
      Throws:
      OperationFailedException - unable to complete request
      Compliance:
      mandatory - This method must be implemented.

    • isSubdivision

      boolean isSubdivision()
      Tests if this room is a subdivision of another room.
      Returns:
      true if this room is a subdivisiaion, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • getEnclosingRoomId

      Id getEnclosingRoomId()
      Gets the enclosing room Id if this room is a subdivision.
      Returns:
      the enclosing room Id
      Throws:
      IllegalStateException - isSubdivision() is false
      Compliance:
      mandatory - This method must be implemented.

    • getEnclosingRoom

      Room getEnclosingRoom() throws OperationFailedException
      Gets the enclosing room if this room is a subdivision.
      Returns:
      the enlcosing room
      Throws:
      IllegalStateException - isSubdivision() is false
      OperationFailedException - unable to complete request
      Compliance:
      mandatory - This method must be implemented.

    • getSubdivisionIds

      IdList getSubdivisionIds()
      Gets the subdivision room Ids if this room is subdivided.
      Returns:
      the subdivision room Ids
      Compliance:
      mandatory - This method must be implemented.

    • getSubdivisions

      RoomList getSubdivisions() throws OperationFailedException
      Gets the subdivision rooms if this room is subdivided.
      Returns:
      the subdivision rooms
      Throws:
      OperationFailedException - unable to complete request
      Compliance:
      mandatory - This method must be implemented.

    • getDesignatedName

      DisplayText getDesignatedName()
      Gets the designated or formal name of the room (e.g. Twenty Chimneys). The display name may be mapped to this designated name, room number, or some other room label.
      Returns:
      the room number
      Compliance:
      mandatory - This method must be implemented.

    • getRoomNumber

      String getRoomNumber()
      Gets the complete room number including the building and floor (e.g. W20-306).
      Returns:
      the room number
      Compliance:
      mandatory - This method must be implemented.

    • getCode

      String getCode()
      Gets the room number within a floor (e.g. 06).
      Returns:
      the room code
      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.

    • getArea

      BigDecimal getArea()
      Gets the area of this room in square feet.
      Returns:
      the area in square feet
      Throws:
      IllegalStateException - hasArea() is false
      Compliance:
      mandatory - This method must be implemented.

    • getOccupancyLimit

      long getOccupancyLimit()
      Gets the limit on occupancy of this room.
      Returns:
      the occupancy limit
      Compliance:
      mandatory - This method must be implemented.

    • getResourceIds

      IdList getResourceIds()
      Gets the Ids of any resources in this room such as projectors, white boards, or other classes of equiptment.
      Returns:
      the resource Ids
      Compliance:
      mandatory - This method must be implemented.

    • getResources

      ResourceList getResources() throws OperationFailedException
      Gets a list of resources in this room such as projectors, white boards, or other classes of equiptment. These classes of equipment are expressed as resources although they may be managed at the individual item level in the Inventory OSID. These resources are to facilitate searches among equipped rooms.
      Returns:
      a list of resources
      Throws:
      OperationFailedException - unable to complete request
      Compliance:
      mandatory - This method must be implemented.

    • getRoomRecord

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