org.osid.course.chronicle

Interface ProgramEntrySearchOrder

All Superinterfaces:

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

public interface ProgramEntrySearchOrder
extends OsidRelationshipSearchOrder

An interface for specifying the ordering of search results.

Method Summary

Methods

Modifier and Type	Method and Description
GradeSystemSearchOrder	getCreditScaleSearchOrder() Gets the grade system order.
GradeSystemSearchOrder	getGPAScaleSearchOrder() Gets the grade system order.
ProgramEntrySearchOrderRecord	getProgramEntrySearchOrderRecord(Type programEntryRecordType) Gets the program entry search order record corresponding to the given program entry record Type.
ProgramSearchOrder	getProgramSearchOrder() Gets the program order.
ResourceSearchOrder	getStudentSearchOrder() Gets the resource order.
TermSearchOrder	getTermSearchOrder() Gets the term order.
void	orderByAdmissionDate(SearchOrderStyle style) Specifies a preference for ordering the result set by the admission date.
void	orderByComplete(SearchOrderStyle style) Specifies a preference for ordering the result set by completed programs.
void	orderByCreditScale(SearchOrderStyle style) Specifies a preference for ordering the result set by the grade system for credits.
void	orderByCreditsEarned(SearchOrderStyle style) Specifies a preference for ordering the result set by the earned credits.
void	orderByGPA(SearchOrderStyle style) Specifies a preference for ordering the result set by the gpa.
void	orderByGPAScale(SearchOrderStyle style) Specifies a preference for ordering the result set by the grade system for GPAs.
void	orderByProgram(SearchOrderStyle style) Specifies a preference for ordering the result set by the program.
void	orderByStudent(SearchOrderStyle style) Specifies a preference for ordering the result set by the resource.
void	orderByTerm(SearchOrderStyle style) Specifies a preference for ordering the result set by the term.
boolean	supportsCreditScaleSearchOrder() Tests if a grade system order is available.
boolean	supportsGPAScaleSearchOrder() Tests if a grade system order is available.
boolean	supportsProgramSearchOrder() Tests if a program order is available.
boolean	supportsStudentSearchOrder() Tests if a resource order is available.
boolean	supportsTermSearchOrder() Tests if a term 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

orderByStudent

void orderByStudent(SearchOrderStyle style)

Specifies a preference for ordering the result set by the resource.

Parameters:

style - search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

supportsStudentSearchOrder

boolean supportsStudentSearchOrder()

Tests if a resource order is available.

Returns:

true if a resource order is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getStudentSearchOrder

ResourceSearchOrder getStudentSearchOrder()

Gets the resource order.

Returns:

the resource search order

Throws:

UnimplementedException - supportsStudentSearchOrder() is false

Compliance:

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

orderByProgram

void orderByProgram(SearchOrderStyle style)

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

Parameters:

style - search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

supportsProgramSearchOrder

boolean supportsProgramSearchOrder()

Tests if a program order is available.

Returns:

true if a program order is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getProgramSearchOrder

ProgramSearchOrder getProgramSearchOrder()

Gets the program order.

Returns:

the program search order

Throws:

UnimplementedException - supportsProgramSearchOrder() is false

Compliance:

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

orderByAdmissionDate

void orderByAdmissionDate(SearchOrderStyle style)

Specifies a preference for ordering the result set by the admission date.

Parameters:

style - search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

orderByComplete

void orderByComplete(SearchOrderStyle style)

Specifies a preference for ordering the result set by completed programs.

Parameters:

style - search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

orderByTerm

void orderByTerm(SearchOrderStyle style)

Specifies a preference for ordering the result set by the term.

Parameters:

style - search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

supportsTermSearchOrder

boolean supportsTermSearchOrder()

Tests if a term order is available.

Returns:

true if a term order is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getTermSearchOrder

TermSearchOrder getTermSearchOrder()

Gets the term order.

Returns:

the term search order

Throws:

UnimplementedException - supportsTermSearchOrder() is false

Compliance:

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

orderByCreditScale

void orderByCreditScale(SearchOrderStyle style)

Specifies a preference for ordering the result set by the grade system for credits.

Parameters:

style - search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

supportsCreditScaleSearchOrder

boolean supportsCreditScaleSearchOrder()

Tests if a grade system order is available.

Returns:

true if a grade system order is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getCreditScaleSearchOrder

GradeSystemSearchOrder getCreditScaleSearchOrder()

Gets the grade system order.

Returns:

the credit scale search order

Throws:

UnimplementedException - supportsCreditScaleSearchOrder() is false

Compliance:

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

orderByCreditsEarned

void orderByCreditsEarned(SearchOrderStyle style)

Specifies a preference for ordering the result set by the earned credits.

Parameters:

style - search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

orderByGPAScale

void orderByGPAScale(SearchOrderStyle style)

Specifies a preference for ordering the result set by the grade system for GPAs.

Parameters:

style - search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

supportsGPAScaleSearchOrder

boolean supportsGPAScaleSearchOrder()

Tests if a grade system order is available.

Returns:

true if a grade system order is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getGPAScaleSearchOrder

GradeSystemSearchOrder getGPAScaleSearchOrder()

Gets the grade system order.

Returns:

the GPA scale search order

Throws:

UnimplementedException - supportsGPAScaleSearchOrder() is false

Compliance:

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

orderByGPA

void orderByGPA(SearchOrderStyle style)

Specifies a preference for ordering the result set by the gpa.

Parameters:

style - search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

getProgramEntrySearchOrderRecord

ProgramEntrySearchOrderRecord getProgramEntrySearchOrderRecord(Type programEntryRecordType)
                                                               throws OperationFailedException

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

Parameters:

programEntryRecordType - a program entry record type

Returns:

the program entry search order record

Throws:

NullArgumentException - programEntryRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(programEntryRecordType) is false

Compliance:

mandatory - This method must be implemented.