org.osid.course.registration

Interface ActivityBundleSearchOrder

All Superinterfaces:

Extensible, OsidBrowsableSearchOrder, OsidExtensibleSearchOrder, OsidIdentifiableSearchOrder, OsidObjectSearchOrder, OsidSearchOrder, Suppliable

public interface ActivityBundleSearchOrder
extends OsidObjectSearchOrder

An interface for specifying the ordering of search results.

Method Summary

Methods

Modifier and Type	Method and Description
ActivityBundleSearchOrderRecord	getActivityBundleSearchOrderRecord(Type activityBundleRecordType) Gets the activity bundle search order record corresponding to the given activity bundle record Type.
CourseOfferingSearchOrder	getCourseOfferingSearchOrder() Gets the course offering order.
void	orderByCourseOffering(SearchOrderStyle style) Specifies a preference for ordering the result set by course offering.
boolean	supportsCourseOfferingSearchOrder() Tests if a course offering order is available.

Methods inherited from interface org.osid.OsidObjectSearchOrder

orderByCreateTime, orderByCumulativeRating, orderByDescription, orderByDisplayName, orderByGenusType, orderByLastModifiedTime, orderByState, orderByStatistic

Methods inherited from interface org.osid.OsidIdentifiableSearchOrder

orderById

Methods inherited from interface org.osid.Extensible

getRecordTypes, hasRecordType

Method Detail

orderByCourseOffering

void orderByCourseOffering(SearchOrderStyle style)

Specifies a preference for ordering the result set by course offering.

Parameters:

style - a search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

supportsCourseOfferingSearchOrder

boolean supportsCourseOfferingSearchOrder()

Tests if a course offering order is available.

Returns:

true if a course offering order is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getCourseOfferingSearchOrder

CourseOfferingSearchOrder getCourseOfferingSearchOrder()

Gets the course offering order.

Returns:

the course offering search order

Throws:

UnimplementedException - supportsCourseOfferingSearchOrder() is false

Compliance:

optional - This method must be implemented if supportsCourseSearchOrder() is true.

getActivityBundleSearchOrderRecord

ActivityBundleSearchOrderRecord getActivityBundleSearchOrderRecord(Type activityBundleRecordType)
                                                                   throws OperationFailedException

Gets the activity bundle search order record corresponding to the given activity bundle record Type. Multiple retrievals return the same underlying object.

Parameters:

activityBundleRecordType - an activity bundle record type

Returns:

the activity bundle search order record

Throws:

NullArgumentException - activityBundleRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(activityBundleRecordType) is false

Compliance:

mandatory - This method must be implemented.