Interface DemographicSearch

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

The search interface for governing demographic searches.

  • Method Details

    • searchAmongDemographics

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

    • orderDemographicResults

      void orderDemographicResults(DemographicSearchOrder demographicSearchOrder)
      Specify an ordering to the search results.
      Parameters:
      demographicSearchOrder - demographic search order
      Throws:
      NullArgumentException - demographicSearchOrder is null
      UnsupportedException - demographicSearchOrder is not of this service
      Compliance:
      mandatory - This method must be implemented.

    • getDemographicSearchRecord

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