org.osid.course.registration

Interface ActivityBundleSearch

All Superinterfaces:

Extensible, OsidCondition, OsidSearch, Suppliable

public interface ActivityBundleSearch
extends OsidSearch

The search interface for governing activity bundle searches.

Method Summary

Methods

Modifier and Type	Method and Description
ActivityBundleSearchRecord	getActivityBundleSearchRecord(Type activityBundleSearchRecordType) Gets the activity bundle search record corresponding to the given activity bundle search record Type.
void	orderActivityBundleResults(ActivityBundleSearchOrder activityBundleSearchOrder) Specify an ordering to the search results.
void	searchAmongActivityBundles(IdList activityBundleIds) Execute this search among the given list of activity bundles.

Methods inherited from interface org.osid.OsidSearch

limitResultSet

Methods inherited from interface org.osid.Extensible

getRecordTypes, hasRecordType

Method Detail

searchAmongActivityBundles

void searchAmongActivityBundles(IdList activityBundleIds)

Execute this search among the given list of activity bundles.

Parameters:

activityBundleIds - list of activity bundles

Throws:

NullArgumentException - activityBundleIds is null

Compliance:

mandatory - This method must be implemented.

orderActivityBundleResults

void orderActivityBundleResults(ActivityBundleSearchOrder activityBundleSearchOrder)

Specify an ordering to the search results.

Parameters:

activityBundleSearchOrder - activity bundle search order

Throws:

NullArgumentException - activityBundleSearchOrder is null

UnsupportedException - activityBundleSearchOrder is not of this service

Compliance:

mandatory - This method must be implemented.

getActivityBundleSearchRecord

ActivityBundleSearchRecord getActivityBundleSearchRecord(Type activityBundleSearchRecordType)
                                                         throws OperationFailedException

Gets the activity bundle search 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 record

Throws:

NullArgumentException - activityBundleSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(activityBundleSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.