public interface ProgramEntrySearchOrder extends OsidRelationshipSearchOrder
An interface for specifying the ordering of search results.
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.
|
getEndReasonSearchOrder, orderByEndReason, supportsEndReasonSearchOrder
orderByCreateTime, orderByCumulativeRating, orderByDescription, orderByDisplayName, orderByGenusType, orderByLastModifiedTime, orderByState, orderByStatistic
orderById
getRecordTypes, hasRecordType
orderByEffective, orderByEndDate, orderByStartDate
void orderByStudent(SearchOrderStyle style)
style
- search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. boolean supportsStudentSearchOrder()
true
if a resource order is available,
false
otherwisemandatory
- This method must be implemented. ResourceSearchOrder getStudentSearchOrder()
UnimplementedException
-
supportsStudentSearchOrder()
is false
optional
- This method must be implemented if
supportsStudentSearchOrder()
is true.
void orderByProgram(SearchOrderStyle style)
style
- search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. boolean supportsProgramSearchOrder()
true
if a program order is available,
false
otherwisemandatory
- This method must be implemented. ProgramSearchOrder getProgramSearchOrder()
UnimplementedException
-
supportsProgramSearchOrder()
is false
optional
- This method must be implemented if
supportsProgramSearchOrder()
is true.
void orderByAdmissionDate(SearchOrderStyle style)
style
- search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. void orderByComplete(SearchOrderStyle style)
style
- search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. void orderByTerm(SearchOrderStyle style)
style
- search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. boolean supportsTermSearchOrder()
true
if a term order is available, false
otherwisemandatory
- This method must be implemented. TermSearchOrder getTermSearchOrder()
UnimplementedException
-
supportsTermSearchOrder()
is false
optional
- This method must be implemented if
supportsTermSearchOrder()
is true.
void orderByCreditScale(SearchOrderStyle style)
style
- search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. boolean supportsCreditScaleSearchOrder()
true
if a grade system order is available,
false
otherwisemandatory
- This method must be implemented. GradeSystemSearchOrder getCreditScaleSearchOrder()
UnimplementedException
-
supportsCreditScaleSearchOrder()
is false
optional
- This method must be implemented if
supportsCreditScaleSearchOrder()
is true.
void orderByCreditsEarned(SearchOrderStyle style)
style
- search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. void orderByGPAScale(SearchOrderStyle style)
style
- search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. boolean supportsGPAScaleSearchOrder()
true
if a grade system order is available,
false
otherwisemandatory
- This method must be implemented. GradeSystemSearchOrder getGPAScaleSearchOrder()
UnimplementedException
-
supportsGPAScaleSearchOrder()
is false
optional
- This method must be implemented if
supportsGPAScaleSearchOrder()
is true.
void orderByGPA(SearchOrderStyle style)
style
- search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. ProgramEntrySearchOrderRecord getProgramEntrySearchOrderRecord(Type programEntryRecordType) throws OperationFailedException
Type.
Multiple retrievals return
the same underlying object.programEntryRecordType
- a program entry record typeNullArgumentException
- programEntryRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(programEntryRecordType)
is false
mandatory
- This method must be implemented.