org.osid.course.registration

Interface ActivityBundleSearchResults

All Superinterfaces:

Browsable, Extensible, OsidResult, OsidSearchResults

public interface ActivityBundleSearchResults
extends OsidSearchResults

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

Method Summary

Methods

Modifier and Type	Method and Description
ActivityBundleQueryInspector	getActivityBundleQueryInspector() Gets the inspector for the query to examine the terms used in the search.
ActivityBundleList	getActivityBundles() Gets the activity bundle list resulting from a search.
ActivityBundleSearchResultsRecord	getActivityBundleSearchResultsRecord(Type activityBundleSearchRecordType) Gets the activity bundle search results record corresponding to the given activity bundle 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

getActivityBundles

ActivityBundleList getActivityBundles()

Gets the activity bundle list resulting from a search.

Returns:

the activity bundle list

Throws:

IllegalStateException - the activity bundle list has already been retrieved

Compliance:

mandatory - This method must be implemented.

getActivityBundleQueryInspector

ActivityBundleQueryInspector getActivityBundleQueryInspector()

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.

getActivityBundleSearchResultsRecord

ActivityBundleSearchResultsRecord getActivityBundleSearchResultsRecord(Type activityBundleSearchRecordType)
                                                                       throws OperationFailedException

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

Parameters:

activityBundleSearchRecordType - a activity bundle search record type

Returns:

the activity bundle search results record

Throws:

NullArgumentException - activityBundleSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(activityBundleSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.