OSID - osid.course.ActivitySearchOrder Service Interface Definition

Interface	osid.course.ActivitySearchOrder
Implements	`osid.OsidRelationshipSearchOrder`
Implements	`osid.OsidSubjugateableSearchOrder`
Used By	`osid.course.ActivitySearchSession`
	`osid.course.ActivitySmartCourseCatalogSession`
	`osid.course.plan.LessonSearchOrder`
	`osid.course.registration.ActivityRegistrationSearchOrder`
Description	An interface for specifying the ordering of search results.
Method	orderByActivityUnit
Description	Specifies a preference for ordering the result set by activity unit.
Parameters	`osid.SearchOrderStyle`	`style`	a search order style
Errors	NULL_ARGUMENT		`style` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	supportsActivityUnitSearchOrder
Description	Tests if an activity unit search order is available.
Return	`boolean`		`true` if an activity unit search order is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getActivityUnitSearchOrder
Description	Gets the activity unit search order.
Return	`osid.course.CourseSearchOrder`		the activity unit search order
Errors	UNIMPLEMENTED		`supportsActivityUnitSearchOrder()` is `false`
Compliance	`optional`		This method must be implemented if `supportsActivityUnitSearchOrder()` is `true`.
Method	orderByCourseOffering
Description	Specifies a preference for ordering the result set by course offering.
Parameters	`osid.SearchOrderStyle`	`style`	a search order style
Errors	NULL_ARGUMENT		`style` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	supportsCourseOfferingSearchOrder
Description	Tests if a course offering search is available.
Return	`boolean`		`true` if a course offering search order is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getCourseOfferingSearchOrder
Description	Gets the course offering search order.
Return	`osid.course.CourseOfferingSearchOrder`		the course offering search order
Errors	UNIMPLEMENTED		`supportsCourseOfferingSearchOrder()` is `false`
Compliance	`optional`		This method must be implemented if `supportsActivityUnitSearchOrder()` is `true`.
Method	orderByTerm
Description	Specifies a preference for ordering the result set by term.
Parameters	`osid.SearchOrderStyle`	`style`	a search order style
Errors	NULL_ARGUMENT		`style` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	supportsTermSearchOrder
Description	Tests if a term search order is available.
Return	`boolean`		`true` if a term search 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	orderByImplicit
Description	Specifies a preference for ordering the result set by the implicit status.
Parameters	`osid.SearchOrderStyle`	`style`	a search order style
Errors	NULL_ARGUMENT		`style` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	orderByMinimumSeats
Description	Specifies a preference for ordering the result set by the minimum seats.
Parameters	`osid.SearchOrderStyle`	`style`	a search order style
Errors	NULL_ARGUMENT		`style` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	orderByMaximumSeats
Description	Specifies a preference for ordering the result set by the maximum seats.
Parameters	`osid.SearchOrderStyle`	`style`	a search order style
Errors	NULL_ARGUMENT		`style` is `null`
Compliance	`mandatory`		This method must be implemented.
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	getActivitySearchOrderRecord
Description	Gets the activity search order record corresponding to the given activity record `Type`. Multiple retrievals return the same underlying object.
Parameters	`osid.type.Type`	`activityRecordType`	an activity record type
Return	`osid.course.records.ActivitySearchOrderRecord`		the activity search order record
Errors	NULL_ARGUMENT		`activityRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(activityRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.