Interface ActivitySearchResults

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

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

  • Method Details

    • getActivities

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

    • getActivityQueryInspector

      ActivityQueryInspector getActivityQueryInspector()
      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.

    • getActivitySearchResultsRecord

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