org.osid.course

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 Summary

Methods

Modifier and Type	Method and Description
ActivityList	getActivities() Gets the activity list resulting from a search.
ActivityQueryInspector	getActivityQueryInspector() Gets the inspector for the query to examine the terms used in the search.
ActivitySearchResultsRecord	getActivitySearchResultsRecord(Type activitySearchRecordType) Gets the activity search results record corresponding to the given activity search record Type.

Methods inherited from interface org.osid.OsidSearchResults

getResultSize

Methods inherited from interface org.osid.Extensible

getRecordTypes, hasRecordType

Methods inherited from interface org.osid.Browsable

getProperties, getPropertiesByRecordType

Method Detail

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 - a 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.