Interface PollsSearchResults

All Superinterfaces:
Browsable, Extensible, OsidResult, OsidSearchResults
public interface PollsSearchResults extends OsidSearchResults

This interface provides a means to capture results of a search.

  • Method Details

    • getPolls

      PollsList getPolls()
      Gets the polls list resulting from the search.
      Returns:
      the polls list
      Throws:
      IllegalStateException - list already retrieved
      Compliance:
      mandatory - This method must be implemented.

    • getPollsQueryInspector

      PollsQueryInspector getPollsQueryInspector()
      Gets the inspector for the query to examine the terms used in the search.
      Returns:
      the polls query inspector
      Compliance:
      mandatory - This method must be implemented.

    • getPollsSearchResultsRecord

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