Interface DispatchConstrainerSearchResults

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

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

  • Method Details

    • getDispatchConstrainers

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

    • getDispatchConstrainerQueryInspector

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

    • getDispatchConstrainerSearchResultsRecord

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