Interface AcademySearch

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

The search interface for governing academy searches.

  • Method Details

    • searchAmongAcademies

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

    • orderAcademyResults

      void orderAcademyResults(AcademySearchOrder academysearchOrder)
      Specify an ordering to the search results.
      Parameters:
      academysearchOrder - academy search order
      Throws:
      NullArgumentException - academysearchOrder is null
      UnsupportedException - academysearchOrder is not of this service
      Compliance:
      mandatory - This method must be implemented.

    • getAcademySearchRecord

      AcademySearchRecord getAcademySearchRecord(Type academySearchRecordType) throws OperationFailedException
      Gets the academy search record corresponding to the given academy search record Type. This method is used to retrieve an object implementing the requested record interface.
      Parameters:
      academySearchRecordType - an academy search record type
      Returns:
      the academy search record
      Throws:
      NullArgumentException - academysearchRecordType is null
      OperationFailedException - unable to complete request
      UnsupportedException - hasRecordType(academysearchRecordType) is false
      Compliance:
      mandatory - This method must be implemented.