org.osid.course.registration

Interface ActivityRegistrationSearchOrder

All Superinterfaces:

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

public interface ActivityRegistrationSearchOrder
extends OsidRelationshipSearchOrder

An interface for specifying the ordering of search results.

Method Summary

Methods

Modifier and Type	Method and Description
ActivityRegistrationSearchOrderRecord	getActivityRegistrationSearchOrderRecord(Type activityRegistrationRecordType) Gets the activity registration search order record corresponding to the given activity registration record Type.
ActivitySearchOrder	getActivitySearchOrder() Gets the activity search order.
RegistrationSearchOrder	getRegistrationSearchOrder() Gets the registration search order.
ResourceSearchOrder	getStudentSearchOrder() Gets the student search order.
void	orderByActivity(SearchOrderStyle style) Specifies a preference for ordering the result set by activity.
void	orderByRegistration(SearchOrderStyle style) Specifies a preference for ordering the result set by registration.
void	orderByStudent(SearchOrderStyle style) Specifies a preference for ordering the result set by student.
boolean	supportsActivitySearchOrder() Tests if an activity search order is available.
boolean	supportsRegistrationSearchOrder() Tests if a regiistration 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

orderByRegistration

void orderByRegistration(SearchOrderStyle style)

Specifies a preference for ordering the result set by registration.

Parameters:

style - a search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

supportsRegistrationSearchOrder

boolean supportsRegistrationSearchOrder()

Tests if a regiistration search order is available.

Returns:

true if a registration search order is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getRegistrationSearchOrder

RegistrationSearchOrder getRegistrationSearchOrder()

Gets the registration search order.

Returns:

the registration search order

Throws:

UnimplementedException - supportsRegistrationSearchOrder() is false

Compliance:

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

orderByActivity

void orderByActivity(SearchOrderStyle style)

Specifies a preference for ordering the result set by activity.

Parameters:

style - a search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

supportsActivitySearchOrder

boolean supportsActivitySearchOrder()

Tests if an activity search order is available.

Returns:

true if an activity search order is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getActivitySearchOrder

ActivitySearchOrder getActivitySearchOrder()

Gets the activity search order.

Returns:

the activity search order

Throws:

UnimplementedException - supportsActivitySearchOrder() is false

Compliance:

optional - This method must be implemented if supportsActivitySearchOrder() 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.

getActivityRegistrationSearchOrderRecord

ActivityRegistrationSearchOrderRecord getActivityRegistrationSearchOrderRecord(Type activityRegistrationRecordType)
                                                                               throws OperationFailedException

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

Parameters:

activityRegistrationRecordType - an activity registration record type

Returns:

the activity registration search order record

Throws:

NullArgumentException - activityRegistrationRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(activityRegistrationRecordType) is false

Compliance:

mandatory - This method must be implemented.