Interface RoomSearchOrder

All Superinterfaces:
Extensible, OsidBrowsableSearchOrder, OsidExtensibleSearchOrder, OsidIdentifiableSearchOrder, OsidObjectSearchOrder, OsidSearchOrder, OsidSubjugateableSearchOrder, OsidTemporalSearchOrder, Suppliable
public interface RoomSearchOrder extends OsidObjectSearchOrder, OsidTemporalSearchOrder, OsidSubjugateableSearchOrder

An interface for specifying the ordering of search results.

  • Method Details

    • orderByBuilding

      void orderByBuilding(SearchOrderStyle style)
      Specifies a preference for ordering the result set by the building.
      Parameters:
      style - search order style
      Throws:
      NullArgumentException - style is null
      Compliance:
      mandatory - This method must be implemented.

    • supportsBuildingSearchOrder

      boolean supportsBuildingSearchOrder()
      Tests if a building search order is available.
      Returns:
      true if a building search order is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • getBuildingSearchOrder

      BuildingSearchOrder getBuildingSearchOrder()
      Gets the building search order.
      Returns:
      the building search order
      Throws:
      UnimplementedException - supportsBuildingSearchOrder() is false
      Compliance:
      optional - This method must be implemented if {@code supportsBuildingSearchOrder()} is {@code true} .

    • orderByFloor

      void orderByFloor(SearchOrderStyle style)
      Specifies a preference for ordering the result set by the floor.
      Parameters:
      style - search order style
      Throws:
      NullArgumentException - style is null
      Compliance:
      mandatory - This method must be implemented.

    • supportsFloorSearchOrder

      boolean supportsFloorSearchOrder()
      Tests if a floor order is available.
      Returns:
      true if a floor search order is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • getFloorSearchOrder

      FloorSearchOrder getFloorSearchOrder()
      Gets the floor search order.
      Returns:
      the floor search order
      Throws:
      UnimplementedException - supportsFloorSearchOrder() is false
      Compliance:
      optional - This method must be implemented if {@code supportsFloorSearchOrder()} is {@code true} .

    • orderByEnclosingRoom

      void orderByEnclosingRoom(SearchOrderStyle style)
      Specifies a preference for ordering the result set by the enclosing room.
      Parameters:
      style - search order style
      Throws:
      NullArgumentException - style is null
      Compliance:
      mandatory - This method must be implemented.

    • supportsEnclosingRoomSearchOrder

      boolean supportsEnclosingRoomSearchOrder()
      Tests if a room search order is available.
      Returns:
      true if a room order is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • getEnclosingRoomSearchOrder

      RoomSearchOrder getEnclosingRoomSearchOrder()
      Gets the room search order.
      Returns:
      the enclosing room search order
      Throws:
      UnimplementedException - supportsEnclosingRoomSearchOrder() is false
      Compliance:
      optional - This method must be implemented if {@code supportsEnclosingRoomSearchOrder()} is {@code true} .

    • orderByRoomNumber

      void orderByRoomNumber(SearchOrderStyle style)
      Specifies a preference for ordering the result set by the room number.
      Parameters:
      style - search order style
      Throws:
      NullArgumentException - style is null
      Compliance:
      mandatory - This method must be implemented.

    • orderByCode

      void orderByCode(SearchOrderStyle style)
      Specifies a preference for ordering the result set by the room code.
      Parameters:
      style - search order style
      Throws:
      NullArgumentException - style is null
      Compliance:
      mandatory - This method must be implemented.

    • orderByArea

      void orderByArea(SearchOrderStyle style)
      Specifies a preference for ordering the result set by the room area.
      Parameters:
      style - search order style
      Throws:
      NullArgumentException - style is null
      Compliance:
      mandatory - This method must be implemented.

    • orderByOccupancyLimit

      void orderByOccupancyLimit(SearchOrderStyle style)
      Specifies a preference for ordering the result set by the room occupancy limit.
      Parameters:
      style - search order style
      Throws:
      NullArgumentException - style is null
      Compliance:
      mandatory - This method must be implemented.

    • getRoomSearchOrderRecord

      RoomSearchOrderRecord getRoomSearchOrderRecord(Type roomRecordType) throws OperationFailedException
      Gets the room search order record corresponding to the given room record Type . Multiple retrievals return the same underlying object.
      Parameters:
      roomRecordType - a room record type
      Returns:
      the room search order record
      Throws:
      NullArgumentException - roomRecordType is null
      OperationFailedException - unable to complete request
      UnsupportedException - hasRecordType(roomRecordType) is false
      Compliance:
      mandatory - This method must be implemented.