Interface PublisherSearchResults

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

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

  • Method Details

    • getPublishers

      PublisherList getPublishers()
      Gets the publisher list resulting from a search.
      Returns:
      the publisher list
      Throws:
      IllegalStateException - list has already been retrieved
      Compliance:
      mandatory - This method must be implemented.

    • getPublisherQueryInspector

      PublisherQueryInspector getPublisherQueryInspector()
      Gets the inspector for the query to examine the terns used in the search.
      Returns:
      the query inspector
      Compliance:
      mandatory - This method must be implemented.

    • getPublisherSearchResultsRecord

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