org.osid.course.program

Interface EnrollmentSearchOrder

All Superinterfaces:

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

public interface EnrollmentSearchOrder
extends OsidRelationshipSearchOrder

An interface for specifying the ordering of search results.

Method Summary

Methods

Modifier and Type	Method and Description
EnrollmentSearchOrderRecord	getEnrollmentSearchOrderRecord(Type enrollmentRecordType) Gets the enrollment search order record corresponding to the given enrollment record Type.
ProgramOfferingSearchOrder	getProgramOfferingSearchOrder() Gets the program offering search order.
ResourceSearchOrder	getStudentSearchOrder() Gets the student search order.
void	orderByProgramOffering(SearchOrderStyle style) Specifies a preference for ordering the result set by program offering.
void	orderByStudent(SearchOrderStyle style) Specifies a preference for ordering the result set by student.
boolean	supportsProgramOfferingSearchOrder() Tests if a program offering 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

orderByProgramOffering

void orderByProgramOffering(SearchOrderStyle style)

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

Parameters:

style - a search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

supportsProgramOfferingSearchOrder

boolean supportsProgramOfferingSearchOrder()

Tests if a program offering search order is available.

Returns:

true if a program offering order is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getProgramOfferingSearchOrder

ProgramOfferingSearchOrder getProgramOfferingSearchOrder()

Gets the program offering search order.

Returns:

the program offering search order

Throws:

UnimplementedException - supportsProgramOfferingSearchOrder() is false

Compliance:

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

getEnrollmentSearchOrderRecord

EnrollmentSearchOrderRecord getEnrollmentSearchOrderRecord(Type enrollmentRecordType)
                                                           throws OperationFailedException

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

Parameters:

enrollmentRecordType - an enrollment record type

Returns:

the enrollment search order record

Throws:

NullArgumentException - enrollmentRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(enrollmentRecordType) is false

Compliance:

mandatory - This method must be implemented.