org.osid.course.registration

Interface RegistrationSearchOrder

All Superinterfaces:

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

public interface RegistrationSearchOrder
extends OsidRelationshipSearchOrder

An interface for specifying the ordering of search results.

Method Summary

Methods

Modifier and Type	Method and Description
ActivityBundleSearchOrder	getActivityBundleSearchOrder() Gets the activity bundle search order.
GradeSystemSearchOrder	getGradingOptionSearchOrder() Gets the grade system search order.
RegistrationSearchOrderRecord	getRegistrationSearchOrderRecord(Type registrationRecordType) Gets the registration search order record corresponding to the given registration record Type.
ResourceSearchOrder	getStudentSearchOrder() Gets the student search order.
void	orderByActivityBundle(SearchOrderStyle style) Specifies a preference for ordering the result set by activity bundle.
void	orderByGradingOption(SearchOrderStyle style) Specifies a preference for ordering the result set by the grading option.
void	orderByStudent(SearchOrderStyle style) Specifies a preference for ordering the result set by student.
boolean	supportsActivityBundleSearchOrder() Tests if an activity bundle search order is available.
boolean	supportsGradingOptionSearchOrder() Tests if a grade system search order is available.
boolean	supportsStudentSearchOrder() Tests if a student search order is available.

Methods inherited from interface org.osid.OsidRelationshipSearchOrder

getEndReasonSearchOrder, orderByEndReason, supportsEndReasonSearchOrder

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

Methods inherited from interface org.osid.OsidTemporalSearchOrder

orderByEffective, orderByEndDate, orderByStartDate

Method Detail

orderByActivityBundle

void orderByActivityBundle(SearchOrderStyle style)

Specifies a preference for ordering the result set by activity bundle.

Parameters:

style - a search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

supportsActivityBundleSearchOrder

boolean supportsActivityBundleSearchOrder()

Tests if an activity bundle search order is available.

Returns:

true if an activity bundle search order is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getActivityBundleSearchOrder

ActivityBundleSearchOrder getActivityBundleSearchOrder()

Gets the activity bundle search order.

Returns:

the activity bundle search order

Throws:

UnimplementedException - supportsActivityBundleSearchOrder() is false

Compliance:

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

orderByStudent

void orderByStudent(SearchOrderStyle style)

Specifies a preference for ordering the result set by student.

Parameters:

style - a search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

supportsStudentSearchOrder

boolean supportsStudentSearchOrder()

Tests if a student search order is available.

Returns:

true if a student search order is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getStudentSearchOrder

ResourceSearchOrder getStudentSearchOrder()

Gets the student search order.

Returns:

the student search order

Throws:

UnimplementedException - supportsStudentSearchOrder() is false

Compliance:

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

orderByGradingOption

void orderByGradingOption(SearchOrderStyle style)

Specifies a preference for ordering the result set by the grading option.

Parameters:

style - a search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

supportsGradingOptionSearchOrder

boolean supportsGradingOptionSearchOrder()

Tests if a grade system search order is available.

Returns:

true if a grade system order is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getGradingOptionSearchOrder

GradeSystemSearchOrder getGradingOptionSearchOrder()

Gets the grade system search order.

Returns:

the grade system search order

Throws:

UnimplementedException - supportsGradingOptionSearchOrder() is false

Compliance:

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

getRegistrationSearchOrderRecord

RegistrationSearchOrderRecord getRegistrationSearchOrderRecord(Type registrationRecordType)
                                                               throws OperationFailedException

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

Parameters:

registrationRecordType - a registration record type

Returns:

the registration search order record

Throws:

NullArgumentException - registrationRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(registrationRecordType) is false

Compliance:

mandatory - This method must be implemented.