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

Interface	osid.course.plan.PlanSearchOrder
Implements	`osid.OsidRelationshipSearchOrder`
Used By	`osid.course.plan.LessonSearchOrder`
	`osid.course.plan.PlanSearchSession`
	`osid.course.plan.PlanSmartCourseCatalogSession`
Description	An interface for specifying the ordering of search results.
Method	orderBySyllabus
Description	Specifies a preference for ordering the result set by the syllabus.
Parameters	`osid.SearchOrderStyle`	`style`	search order style
Errors	NULL_ARGUMENT		`style` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	supportsSyllabusSearchOrder
Description	Tests if a syllabus order is available.
Return	`boolean`		`true` if a syllabus order is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getSyllabusSearchOrder
Description	Gets the syllabus order.
Return	`osid.course.syllabus.SyllabusSearchOrder`		the syllabus search order
Errors	UNIMPLEMENTED		`supportsSyllabusSearchOrder()` is `false`
Compliance	`optional`		This method must be implemented if `supportsCourseSearchOrder()` is `true` .
Method	orderByCourseOffering
Description	Specifies a preference for ordering the result set by the course offering.
Parameters	`osid.SearchOrderStyle`	`style`	search order style
Errors	NULL_ARGUMENT		`style` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	supportsCourseOfferingSearchOrder
Description	Tests if a course offering order is available.
Return	`boolean`		`true` if a course offering order is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getCourseOfferingSearchOrder
Description	Gets the course offering order.
Return	`osid.course.CourseOfferingSearchOrder`		the course offering search order
Errors	UNIMPLEMENTED		`supportsCourseOfferingSearchOrder()` is `false`
Compliance	`optional`		This method must be implemented if `supportsCourseSearchOrder()` is `true` .
Method	getPlanSearchOrderRecord
Description	Gets the plan search order record corresponding to the given plan record `Type` . Multiple retrievals return the same underlying object.
Parameters	`osid.type.Type`	`planRecordType`	a plan record type
Return	`osid.course.plan.records.PlanSearchOrderRecord`		the plan search order record
Errors	NULL_ARGUMENT		`planRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(planRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.