Interface PoolSearch

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

The search interface for governing pool searches.

  • Method Details

    • searchAmongPools

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

    • orderPoolResults

      void orderPoolResults(PoolSearchOrder poolSearchOrder)
      Specify an ordering to the search results.
      Parameters:
      poolSearchOrder - pool search order
      Throws:
      NullArgumentException - poolSearchOrder is null
      UnsupportedException - poolSearchOrder is not of this service
      Compliance:
      mandatory - This method must be implemented.

    • getPoolSearchRecord

      PoolSearchRecord getPoolSearchRecord(Type poolSearchRecordType) throws OperationFailedException
      Gets the pool search record corresponding to the given pool search record Type. This method is used to retrieve an object implementing the requested record.
      Parameters:
      poolSearchRecordType - a pool search record type
      Returns:
      the pool search record
      Throws:
      NullArgumentException - poolSearchRecordType is null
      OperationFailedException - unable to complete request
      UnsupportedException - hasRecordType(poolSearchRecordType) is false
      Compliance:
      mandatory - This method must be implemented.