Interface AssetContentSearchResults

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

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

  • Method Details

    • getAssetContents

      AssetContentList getAssetContents()
      Gets the asset content list resulting from a search.
      Returns:
      the asset content list
      Throws:
      IllegalStateException - list already retrieved
      Compliance:
      mandatory - This method must be implemented.

    • getAssetContentQueryInspector

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

    • getAssetContentSearchResultsRecord

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