Interface CheckSearchResults

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

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

  • Method Details

    • getChecks

      CheckList getChecks()
      Gets the check list resulting from a search.
      Returns:
      the check list
      Throws:
      IllegalStateException - list already retrieved
      Compliance:
      mandatory - This method must be implemented.

    • getCheckQueryInspector

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

    • getCheckSearchResultsRecord

      CheckSearchResultsRecord getCheckSearchResultsRecord(Type checkSearchRecordType) throws OperationFailedException, PermissionDeniedException
      Gets the check search results record corresponding to the given check search record Type.This method is used to retrieve an object implementing the requested record.
      Parameters:
      checkSearchRecordType - a check search record type
      Returns:
      the check search results record
      Throws:
      NullArgumentException - checkSearchRecordType is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure occurred
      UnsupportedException - hasRecordType(checkSearchRecordType) is false
      Compliance:
      mandatory - This method must be implemented.