Interface QueueConstrainerSearchResults

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

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

  • Method Details

    • getQueueConstrainers

      QueueConstrainerList getQueueConstrainers()
      Gets the queue constrainer list resulting from a search.
      Returns:
      the queue constrainer list
      Throws:
      IllegalStateException - list already retrieved
      Compliance:
      mandatory - This method must be implemented.

    • getQueueConstrainerQueryInspector

      QueueConstrainerQueryInspector getQueueConstrainerQueryInspector()
      Gets the inspector for the query to examine the terms used in the search.
      Returns:
      the queue constrainer query inspector
      Compliance:
      mandatory - This method must be implemented.

    • getQueueConstrainerSearchResultsRecord

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