org.osid.course

Interface ActivityUnitSearchResults

All Superinterfaces:

Browsable, Extensible, OsidResult, OsidSearchResults

public interface ActivityUnitSearchResults
extends OsidSearchResults

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

Method Summary

Methods

Modifier and Type	Method and Description
ActivityUnitQueryInspector	getActivityUnitQueryInspector() Gets the inspector for the query to examine the terms used in the search.
ActivityUnitList	getActivityUnits() Gets the activity unit list resulting from a search.
ActivityUnitSearchResultsRecord	getActivityUnitSearchResultsRecord(Type activityUnitSearchRecordType) Gets the activity unit search results record corresponding to the given activity unit 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

getActivityUnits

ActivityUnitList getActivityUnits()

Gets the activity unit list resulting from a search.

Returns:

the activity unit list

Throws:

IllegalStateException - the activity unit list has already been retrieved

Compliance:

mandatory - This method must be implemented.

getActivityUnitQueryInspector

ActivityUnitQueryInspector getActivityUnitQueryInspector()

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.

getActivityUnitSearchResultsRecord

ActivityUnitSearchResultsRecord getActivityUnitSearchResultsRecord(Type activityUnitSearchRecordType)
                                                                   throws OperationFailedException

Gets the activity unit search results record corresponding to the given activity unit search record Type. This method is used to retrieve an object implementing the requested record.

Parameters:

activityUnitSearchRecordType - a activity unit search record type

Returns:

the activity unit search results record

Throws:

NullArgumentException - activityUnitSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(activityUnitSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.