OSID - osid.course.ActivityUnitSearchOrder Service Interface Definition

Interface	osid.course.ActivityUnitSearchOrder
Implements	`osid.OsidObjectSearchOrder`
	`osid.OsidOperableSearchOrder`
	`osid.OsidSubjugateableSearchOrder`
Used By	`osid.course.ActivityUnitSearchSession`
	`osid.course.ActivityUnitSmartCourseCatalogSession`
	`osid.course.syllabus.DocetSearchOrder`
Description	An interface for specifying the ordering of search results.
Method	orderByCourse
Description	Specifies a preference for ordering the result set by course.
Parameters	`osid.SearchOrderStyle`	`style`	a search order style
Errors	NULL_ARGUMENT		`style` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	supportsCourseSearchOrder
Description	Tests if a course order is available.
Return	`boolean`		`true` if a course order is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getCourseSearchOrder
Description	Gets the course order.
Return	`osid.course.CourseSearchOrder`		the course search order
Errors	UNIMPLEMENTED		`supportsCourseSearchOrder()` is `false`
Compliance	`optional`		This method must be implemented if `supportsCourseSearchOrder()` is `true`.
Method	orderByTotalTargetEffort
Description	Specifies a preference for ordering the result set by the total effort.
Parameters	`osid.SearchOrderStyle`	`style`	a search order style
Errors	NULL_ARGUMENT		`style` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	orderByTotalTargetContactTime
Description	Specifies a preference for ordering the result set by the total contact.
Parameters	`osid.SearchOrderStyle`	`style`	a search order style
Errors	NULL_ARGUMENT		`style` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	orderByTotalTargetIndividualEffort
Description	Specifies a preference for ordering the result set by total individual effort.
Parameters	`osid.SearchOrderStyle`	`style`	a search order style
Errors	NULL_ARGUMENT		`style` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	orderByRecurringWeekly
Description	Specifies a preference for ordering the result set by weekly recurring.
Parameters	`osid.SearchOrderStyle`	`style`	a search order style
Errors	NULL_ARGUMENT		`style` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	orderByWeeklyEffort
Description	Specifies a preference for ordering the result set by the weekly effort.
Parameters	`osid.SearchOrderStyle`	`style`	a search order style
Errors	NULL_ARGUMENT		`style` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	orderByWeeklyContactTime
Description	Specifies a preference for ordering the result set by the weekly contact.
Parameters	`osid.SearchOrderStyle`	`style`	a search order style
Errors	NULL_ARGUMENT		`style` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	orderByWeeklyIndividualEffort
Description	Specifies a preference for ordering the result set by weekly individual effort.
Parameters	`osid.SearchOrderStyle`	`style`	a search order style
Errors	NULL_ARGUMENT		`style` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getActivityUnitSearchOrderRecord
Description	Gets the activity unit search order record corresponding to the given activity unit record `Type`. Multiple retrievals return the same underlying object.
Parameters	`osid.type.Type`	`activityUnitRecordType`	an activity unit record type
Return	`osid.course.records.ActivityUnitSearchOrderRecord`		the activity unit search order record
Errors	NULL_ARGUMENT		`activityUnitRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(activityUnitRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.