Interface AssetSearchResults

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

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

  • Method Details

    • getAssets

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

    • getAssetQueryInspector

      AssetQueryInspector getAssetQueryInspector()
      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.

    • getAssetSearchResultsRecord

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