Interface FloorSearch

All Superinterfaces:
Extensible, OsidCondition, OsidSearch, Suppliable
public interface FloorSearch extends OsidSearch

The search interface for governing floor searches.

  • Method Details

    • searchAmongFloors

      void searchAmongFloors(IdList floorIds)
      Execute this search among the given list of floors.
      Parameters:
      floorIds - list of floors
      Throws:
      NullArgumentException - floorIds is null
      Compliance:
      mandatory - This method must be implemented.

    • orderFloorResults

      void orderFloorResults(FloorSearchOrder floorSearchOrder)
      Specify an ordering to the search results.
      Parameters:
      floorSearchOrder - floor search order
      Throws:
      NullArgumentException - floorSearchOrder is null
      UnsupportedException - floorSearchOrder is not of this service
      Compliance:
      mandatory - This method must be implemented.

    • getFloorSearchRecord

      FloorSearchRecord getFloorSearchRecord(Type floorSearchRecordType) throws OperationFailedException
      Gets the dis[atch search record corresponding to the given floor search record Type. This method is used to retrieve an object implementing the requested record.
      Parameters:
      floorSearchRecordType - a floor search record type
      Returns:
      the floor search record
      Throws:
      NullArgumentException - floorSearchRecordType is null
      OperationFailedException - unable to complete request
      UnsupportedException - hasRecordType(floorSearchRecordType) is false
      Compliance:
      mandatory - This method must be implemented.