Interface UtilitySearch

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

The search interface for governing utility searches.

  • Method Details

    • searchAmongUtilities

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

    • orderUtilityResults

      void orderUtilityResults(UtilitySearchOrder utilitySearchOrder)
      Specify an ordering to the search results.
      Parameters:
      utilitySearchOrder - utility search order
      Throws:
      NullArgumentException - utilitySearchOrder is null
      UnsupportedException - utilitySearchOrder is not of this service
      Compliance:
      mandatory - This method must be implemented.

    • getUtilitySearchRecord

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