Interface BlockSearchResults

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

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

  • Method Details

    • getBlocks

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

    • getBlockQueryInspector

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

    • getBlockSearchResultsRecord

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