Interface CommissionSearch

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

The search interface for governing commission searches.

  • Method Details

    • searchAmongCommissions

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

    • orderCommissionResults

      void orderCommissionResults(CommissionSearchOrder commissionSearchOrder)
      Specify an ordering to the search results.
      Parameters:
      commissionSearchOrder - commission search order
      Throws:
      NullArgumentException - commissionSearchOrder is null
      UnsupportedException - commissionSearchOrder is not of this service
      Compliance:
      mandatory - This method must be implemented.

    • getCommissionSearchRecord

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