Interface RegistrationTargetSearchOrder

All Superinterfaces:

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

public interface RegistrationTargetSearchOrder
extends OsidObjectSearchOrder, OsidSubjugateableSearchOrder

An interface for specifying the ordering of search results.

Method Summary

Modifier and Type	Method	Description
CourseOfferingSearchOrder	getCourseOfferingSearchOrder()	Gets the course offering order.
RegistrationTargetSearchOrderRecord	getRegistrationTargetSearchOrderRecord(Type registrationTargetRecordType)	Gets the registration target search order record corresponding to the given registration target record Type .
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 Extensible

getRecordTypes, hasRecordType

Modifier and Type	Method	Description
TypeList	getRecordTypes()	Gets the record types available in this object.
boolean	hasRecordType(Type recordType)	Tests if this object supports the given record Type .

Methods inherited from interface OsidIdentifiableSearchOrder

orderById

Modifier and Type	Method	Description
void	orderById(SearchOrderStyle style)	Specifies a preference for ordering the result set by the Id .

Methods inherited from interface OsidObjectSearchOrder

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

Modifier and Type	Method	Description
void	orderByCreateTime(SearchOrderStyle style)	Orders by the timestamp of the first journal entry.
void	orderByCumulativeRating(Id bookId, SearchOrderStyle style)	Orders by the cumulative rating in a given Book .
void	orderByDescription(SearchOrderStyle style)	Specifies a preference for ordering the result set by the description.
void	orderByDisplayName(SearchOrderStyle style)	Specifies a preference for ordering the result set by the display name.
void	orderByGenusType(SearchOrderStyle style)	Specifies a preference for ordering the result set by the genus type.
void	orderByLastModifiedTime(SearchOrderStyle style)	Orders by the timestamp of the last journal entry.
void	orderByState(Id processId, SearchOrderStyle style)	Orders by the state in a given Process .
void	orderByStatistic(Id meterId, SearchOrderStyle style)	Orders by a statistic for a given Meter .

Method Details

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 {@code supportsCourseSearchOrder()} is {@code true} .

getRegistrationTargetSearchOrderRecord

RegistrationTargetSearchOrderRecord getRegistrationTargetSearchOrderRecord(Type registrationTargetRecordType)
                                                                    throws OperationFailedException

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

Parameters:

registrationTargetRecordType - a registration target record type

Returns:

the registration target search order record

Throws:

NullArgumentException - registrationTargetRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(registrationTargetRecordType) is false

Compliance:

mandatory - This method must be implemented.