Interface InventorySearchResults

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

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

  • Method Details

    • getInventories

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

    • getInventoryQueryInspector

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

    • getInventorySearchResultsRecord

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