OSID - osid.course.plan.LessonSearchOrder Service Interface Definition

Interface	osid.course.plan.LessonSearchOrder
Implements	`osid.OsidRelationshipSearchOrder`
Used By	`osid.course.plan.LessonSearchSession`
Used By	`osid.course.plan.LessonSmartCourseCatalogSession`
Description	An interface for specifying the ordering of search results.
Method	orderByPlan
Description	Specified a preference for ordering results by the plan.
Parameters	`osid.SearchOrderStyle`	`style`	search order style
Errors	NULL_ARGUMENT		`style` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	supportsPlanSearchOrder
Description	Tests if a `PlanSearchOrder` is available.
Return	`boolean`		`true` if a plan search order is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getPlanSearchOrder
Description	Gets the search order for a plan.
Return	`osid.course.plan.PlanSearchOrder`		the plan search order
Errors	UNIMPLEMENTED		`supportsPlanSearchOrder()` is `false`
Compliance	`optional`		This method must be implemented if `supportsPlanSearchOrder()` is `true`.
Method	orderByDocet
Description	Specified a preference for ordering results by the docet.
Parameters	`osid.SearchOrderStyle`	`style`	search order style
Errors	NULL_ARGUMENT		`style` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	supportsDocetSearchOrder
Description	Tests if a `DocetSearchOrder` is available.
Return	`boolean`		`true` if a docet search order is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getDocetSearchOrder
Description	Gets the search order for a docet.
Return	`osid.course.syllabus.DocetSearchOrder`		the docet search order
Errors	UNIMPLEMENTED		`supportsDocetSearchOrder()` is `false`
Compliance	`optional`		This method must be implemented if `supportsDocetSearchOrder()` is `true`.
Method	orderByPlannedStartTime
Description	Specified a preference for ordering results by the planned start time.
Parameters	`osid.SearchOrderStyle`	`style`	search order style
Errors	NULL_ARGUMENT		`style` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	orderByBegun
Description	Specified a preference for ordering results by the begun flag.
Parameters	`osid.SearchOrderStyle`	`style`	search order style
Errors	NULL_ARGUMENT		`style` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	orderByActualStartTime
Description	Specified a preference for ordering results by the actual start time.
Parameters	`osid.SearchOrderStyle`	`style`	search order style
Errors	NULL_ARGUMENT		`style` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	orderByActualStartingActivity
Description	Specified a preference for ordering results by the actual starting activity.
Parameters	`osid.SearchOrderStyle`	`style`	search order style
Errors	NULL_ARGUMENT		`style` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	supportsActualStartingActivitySearchOrder
Description	Tests if an `ActivitySearchOrder` is available.
Return	`boolean`		`true` if an activity search order is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getActualStartingActivitySearchOrder
Description	Gets the search order for an actual starting actvity.
Return	`osid.course.ActivitySearchOrder`		the activity search order
Errors	UNIMPLEMENTED		`supportsActualStartingActivitySearchOrder()` is `false`
Compliance	`optional`		This method must be implemented if `supportsActualStartingActivitySearchOrder()` is `true`.
Method	orderByComplete
Description	Specified a preference for ordering results by the complete flag.
Parameters	`osid.SearchOrderStyle`	`style`	search order style
Errors	NULL_ARGUMENT		`style` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	orderBySkipped
Description	Specified a preference for ordering results by the skipped flag.
Parameters	`osid.SearchOrderStyle`	`style`	search order style
Errors	NULL_ARGUMENT		`style` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	orderByActualEndTime
Description	Specified a preference for ordering results by the actual end time.
Parameters	`osid.SearchOrderStyle`	`style`	search order style
Errors	NULL_ARGUMENT		`style` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	orderByActualEndingActivity
Description	Specified a preference for ordering results by the actual ending activity.
Parameters	`osid.SearchOrderStyle`	`style`	search order style
Errors	NULL_ARGUMENT		`style` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	supportsActualEndingActivitySearchOrder
Description	Tests if an `ActivitySearchOrder` is available.
Return	`boolean`		`true` if an activity search order is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getActualEndingActivitySearchOrder
Description	Gets the search order for an actual ending actvity.
Return	`osid.course.ActivitySearchOrder`		the activity search order
Errors	UNIMPLEMENTED		`supportsActualEndingActivitySearchOrder()` is `false`
Compliance	`optional`		This method must be implemented if `supportsActualEndingActivitySearchOrder()` is `true`.
Method	orderByActualTimeSpent
Description	Specified a preference for ordering results by the actual time spent.
Parameters	`osid.SearchOrderStyle`	`style`	search order style
Errors	NULL_ARGUMENT		`style` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getLessonSearchOrderRecord
Description	Gets the lesson search order record corresponding to the given lesson record Type. Multiple retrievals return the same underlying object.
Parameters	`osid.type.Type`	`lessonRecordType`	a lesson record type
Return	`osid.course.plan.records.LessonSearchOrderRecord`		the lesson search order record
Errors	NULL_ARGUMENT		`lessonRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(lessonRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.