OSID - osid.course.chronicle.ProgramEntrySearchOrder Service Interface Definition

Interface	osid.course.chronicle.ProgramEntrySearchOrder
Implements	`osid.OsidRelationshipSearchOrder`
Used By	`osid.course.chronicle.ProgramEntrySearchOrder`
	`osid.course.chronicle.ProgramEntrySearchSession`
	`osid.course.chronicle.ProgramEntrySmartCourseCatalogSession`
Description	An interface for specifying the ordering of search results.
Method	orderByStudent
Description	Specifies a preference for ordering the result set by the resource.
Parameters	`osid.SearchOrderStyle`	`style`	search order style
Errors	NULL_ARGUMENT		`style` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	supportsStudentSearchOrder
Description	Tests if a resource order is available.
Return	`boolean`		`true` if a resource order is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getStudentSearchOrder
Description	Gets the resource order.
Return	`osid.resource.ResourceSearchOrder`		the resource search order
Errors	UNIMPLEMENTED		`supportsStudentSearchOrder()` is `false`
Compliance	`optional`		This method must be implemented if `supportsStudentSearchOrder()` is `true`.
Method	orderByProgram
Description	Specifies a preference for ordering the result set by the program.
Parameters	`osid.SearchOrderStyle`	`style`	search order style
Errors	NULL_ARGUMENT		`style` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	supportsProgramSearchOrder
Description	Tests if a program order is available.
Return	`boolean`		`true` if a program order is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getProgramSearchOrder
Description	Gets the program order.
Return	`osid.course.program.ProgramSearchOrder`		the program search order
Errors	UNIMPLEMENTED		`supportsProgramSearchOrder()` is `false`
Compliance	`optional`		This method must be implemented if `supportsProgramSearchOrder()` is `true`.
Method	orderByParentProgramEntry
Description	Specifies a preference for ordering the result set by the parent program entry.
Parameters	`osid.SearchOrderStyle`	`style`	search order style
Errors	NULL_ARGUMENT		`style` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	supportsParentProgramEntrySearchOrder
Description	Tests if a parent program entry order is available.
Return	`boolean`		`true` if a parent program entry order is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getParentProgramEntrySearchOrder
Description	Gets the parent program entry order.
Return	`osid.course.chronicle.ProgramEntrySearchOrder`		the parent program entry search order
Errors	UNIMPLEMENTED		`supportsParentProgramEntrySearchOrder()` is `false`
Compliance	`optional`		This method must be implemented if `supportsParentProgramEntrySearchOrder()` is `true`.
Method	orderByIsMatriculationKnown
Description	Specifies a preference for ordering the result set by the matriculation known flag.
Parameters	`osid.SearchOrderStyle`	`style`	search order style
Errors	NULL_ARGUMENT		`style` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	orderByEntranceDate
Description	Specifies a preference for ordering the result set by the entrance date.
Parameters	`osid.SearchOrderStyle`	`style`	search order style
Errors	NULL_ARGUMENT		`style` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	orderByEntranceTerm
Description	Specifies a preference for ordering the result set by the entrance term.
Parameters	`osid.SearchOrderStyle`	`style`	search order style
Errors	NULL_ARGUMENT		`style` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	supportsEntranceTermSearchOrder
Description	Tests if a entrance term order is available.
Return	`boolean`		`true` if a entrance term order is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getEntranceTermSearchOrder
Description	Gets the entrance term order.
Return	`osid.course.TermSearchOrder`		the entrance term search order
Errors	UNIMPLEMENTED		`supportsEntranceTermSearchOrder()` is `false`
Compliance	`optional`		This method must be implemented if `supportsEntranceTermSearchOrder()` is `true`.
Method	orderByIsExpectedToComplete
Description	Specifies a preference for ordering the result set by the is expected to complete flag.
Parameters	`osid.SearchOrderStyle`	`style`	search order style
Errors	NULL_ARGUMENT		`style` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	orderByExpectedCompletionDate
Description	Specifies a preference for ordering the result set by the expected completion date.
Parameters	`osid.SearchOrderStyle`	`style`	search order style
Errors	NULL_ARGUMENT		`style` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	orderByExpectedCompletionTerm
Description	Specifies a preference for ordering the result set by the expected completion term.
Parameters	`osid.SearchOrderStyle`	`style`	search order style
Errors	NULL_ARGUMENT		`style` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	supportsExpectedCompletionTermSearchOrder
Description	Tests if a expected completion term order is available.
Return	`boolean`		`true` if a expected completion term order is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getExpectedCompletionTermSearchOrder
Description	Gets the expected completion term order.
Return	`osid.course.TermSearchOrder`		the expected completion term search order
Errors	UNIMPLEMENTED		`supportsExpectedCompletionTermSearchOrder()` is `false`
Compliance	`optional`		This method must be implemented if `supportsExpectedCompletionTermSearchOrder()` is `true`.
Method	orderByIsEnrolled
Description	Specifies a preference for ordering the result set by the is enrolled flag.
Parameters	`osid.SearchOrderStyle`	`style`	search order style
Errors	NULL_ARGUMENT		`style` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	orderByIsActivelyEnrolled
Description	Specifies a preference for ordering the result set by the is actively enrolled flag.
Parameters	`osid.SearchOrderStyle`	`style`	search order style
Errors	NULL_ARGUMENT		`style` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	orderByIsOnLeave
Description	Specifies a preference for ordering the result set by the is on leave flag.
Parameters	`osid.SearchOrderStyle`	`style`	search order style
Errors	NULL_ARGUMENT		`style` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	orderByHasWithdrawn
Description	Specifies a preference for ordering the result set by the has withdrawn flag.
Parameters	`osid.SearchOrderStyle`	`style`	search order style
Errors	NULL_ARGUMENT		`style` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	orderByWithdrawDate
Description	Specifies a preference for ordering the result set by the withdraw date.
Parameters	`osid.SearchOrderStyle`	`style`	search order style
Errors	NULL_ARGUMENT		`style` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	orderByWithdrawTerm
Description	Specifies a preference for ordering the result set by the withdraw term.
Parameters	`osid.SearchOrderStyle`	`style`	search order style
Errors	NULL_ARGUMENT		`style` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	supportsWithdrawTermSearchOrder
Description	Tests if a withdraw term order is available.
Return	`boolean`		`true` if a withdraw term order is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getWithdrawTermSearchOrder
Description	Gets the withdraw term order.
Return	`osid.course.TermSearchOrder`		the withdraw term search order
Errors	UNIMPLEMENTED		`supportsWithdrawTermSearchOrder()` is `false`
Compliance	`optional`		This method must be implemented if `supportsWithdrawTermSearchOrder()` is `true`.
Method	orderByComplete
Description	Specifies a preference for ordering the result set by completed programs.
Parameters	`osid.SearchOrderStyle`	`style`	search order style
Errors	NULL_ARGUMENT		`style` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	orderByCompletionDate
Description	Specifies a preference for ordering the result set by the completion date.
Parameters	`osid.SearchOrderStyle`	`style`	search order style
Errors	NULL_ARGUMENT		`style` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	orderByCompletionTerm
Description	Specifies a preference for ordering the result set by the completion term.
Parameters	`osid.SearchOrderStyle`	`style`	search order style
Errors	NULL_ARGUMENT		`style` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	supportsCompletionTermSearchOrder
Description	Tests if a completion term order is available.
Return	`boolean`		`true` if a completion term order is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getCompletionTermSearchOrder
Description	Gets the completion term order.
Return	`osid.course.TermSearchOrder`		the completion term search order
Errors	UNIMPLEMENTED		`supportsCompletionTermSearchOrder()` is `false`
Compliance	`optional`		This method must be implemented if `supportsCompletionTermSearchOrder()` is `true`.
Method	orderByLevel
Description	Specifies a preference for ordering the result set by the level.
Parameters	`osid.SearchOrderStyle`	`style`	search order style
Errors	NULL_ARGUMENT		`style` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	supportsLevelSearchOrder
Description	Tests if a level order is available.
Return	`boolean`		`true` if a level order is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getLevelSearchOrder
Description	Gets the level order.
Return	`osid.grading.GradeSearchOrder`		the level search order
Errors	UNIMPLEMENTED		`supportsLevelSearchOrder()` is `false`
Compliance	`optional`		This method must be implemented if `supportsLevelSearchOrder()` is `true`.
Method	orderByStanding
Description	Specifies a preference for ordering the result set by the standing.
Parameters	`osid.SearchOrderStyle`	`style`	search order style
Errors	NULL_ARGUMENT		`style` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	supportsStandingSearchOrder
Description	Tests if a standing order is available.
Return	`boolean`		`true` if a standing order is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getStandingSearchOrder
Description	Gets the standing order.
Return	`osid.grading.GradeSearchOrder`		the standing search order
Errors	UNIMPLEMENTED		`supportsStandingSearchOrder()` is `false`
Compliance	`optional`		This method must be implemented if `supportsStandingSearchOrder()` is `true`.
Method	orderByAdmissionDate
Description	Specifies a preference for ordering the result set by the admission date.
Parameters	`osid.SearchOrderStyle`	`style`	search order style
Errors	NULL_ARGUMENT		`style` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	orderByTerm
Description	Specifies a preference for ordering the result set by the term.
Parameters	`osid.SearchOrderStyle`	`style`	search order style
Errors	NULL_ARGUMENT		`style` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	supportsTermSearchOrder
Description	Tests if a term order is available.
Return	`boolean`		`true` if a term order is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getTermSearchOrder
Description	Gets the term order.
Return	`osid.course.TermSearchOrder`		the term search order
Errors	UNIMPLEMENTED		`supportsTermSearchOrder()` is `false`
Compliance	`optional`		This method must be implemented if `supportsTermSearchOrder()` is `true`.
Method	orderByCreditScale
Description	Specifies a preference for ordering the result set by the grade system for credits.
Parameters	`osid.SearchOrderStyle`	`style`	search order style
Errors	NULL_ARGUMENT		`style` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	supportsCreditScaleSearchOrder
Description	Tests if a grade system order is available.
Return	`boolean`		`true` if a grade system order is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getCreditScaleSearchOrder
Description	Gets the grade system order.
Return	`osid.grading.GradeSystemSearchOrder`		the credit scale search order
Errors	UNIMPLEMENTED		`supportsCreditScaleSearchOrder()` is `false`
Compliance	`optional`		This method must be implemented if `supportsCreditScaleSearchOrder()` is `true`.
Method	orderByCreditsEarned
Description	Specifies a preference for ordering the result set by the earned credits.
Parameters	`osid.SearchOrderStyle`	`style`	search order style
Errors	NULL_ARGUMENT		`style` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	orderByGPAScale
Description	Specifies a preference for ordering the result set by the grade system for GPAs.
Parameters	`osid.SearchOrderStyle`	`style`	search order style
Errors	NULL_ARGUMENT		`style` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	supportsGPAScaleSearchOrder
Description	Tests if a grade system order is available.
Return	`boolean`		`true` if a grade system order is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getGPAScaleSearchOrder
Description	Gets the grade system order.
Return	`osid.grading.GradeSystemSearchOrder`		the GPA scale search order
Errors	UNIMPLEMENTED		`supportsGPAScaleSearchOrder()` is `false`
Compliance	`optional`		This method must be implemented if `supportsGPAScaleSearchOrder()` is `true`.
Method	orderByGPA
Description	Specifies a preference for ordering the result set by the gpa.
Parameters	`osid.SearchOrderStyle`	`style`	search order style
Errors	NULL_ARGUMENT		`style` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getProgramEntrySearchOrderRecord
Description	Gets the program entry search order record corresponding to the given program entry record `Type`. Multiple retrievals return the same underlying object.
Parameters	`osid.type.Type`	`programEntryRecordType`	a program entry record type
Return	`osid.course.chronicle.records.ProgramEntrySearchOrderRecord`		the program entry search order record
Errors	NULL_ARGUMENT		`programEntryRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(programEntryRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.