OSID - osid.course.ActivityUnit Service Interface Definition

Interface	osid.course.ActivityUnit
Implements	`osid.OsidObject`
	`osid.Operable`
	`osid.Subjugateable`
Used By	`osid.course.Activity`
	`osid.course.ActivityUnitAdminSession`
	`osid.course.ActivityUnitList`
	`osid.course.ActivityUnitLookupSession`
	`osid.course.syllabus.Docet`
Description	An `ActivityUnit` represents a canonical learning unit. A canonical learning unit describes a kind of activity that will be offered and is used for curriculum planning.
Method	getCourseId
Description	Gets the canonical course `Id` associated with this activity.
Return	`osid.id.Id`		the course `Id`
Compliance	`mandatory`		This method must be implemented.
Method	getCourse
Description	Gets the canonical course associated with this activity.
Return	`osid.course.Course`		the course
Errors	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.
Method	getTotalTargetEffort
Description	Gets the total time required for this activity.
Return	`osid.calendaring.Duration`		the total effort
Compliance	`mandatory`		This method must be implemented.
Method	isContact
Description	Tests if this is a contact activity.
Return	`boolean`		`true` if this is a contact activity, `false` if an independent activity
Compliance	`mandatory`		This method must be implemented.
Method	getTotalTargetContactTime
Description	Gets the total contact time for this activity.
Return	`osid.calendaring.Duration`		the total effort
Compliance	`mandatory`		This method must be implemented.
Method	getTotalTargetIndividualEffort
Description	Gets the total indivudal time required for this activity.
Return	`osid.calendaring.Duration`		the total individual effort
Compliance	`mandatory`		This method must be implemented.
Method	isRecurringWeekly
Description	Tests if this activity is recurring.
Return	`boolean`		`true` if this activity is recurring, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getWeeklyEffort
Description	Gets the time required for this recurring effort on a weekly basis.
Return	`osid.calendaring.Duration`		the weekly time
Errors	ILLEGAL_STATE		`isRecurringWeekly()` is `false`
Compliance	`mandatory`		This method must be implemented.
Method	getWeeklyContactTime
Description	Gets the weekly contact time for ths activity.
Return	`osid.calendaring.Duration`		the weekly time
Errors	ILLEGAL_STATE		`isRecurringWeekly()` is `false`
Compliance	`mandatory`		This method must be implemented.
Method	getWeeklyIndividualEffort
Description	Gets the weekly individual time for ths activity.
Return	`osid.calendaring.Duration`		the weekly time
Errors	ILLEGAL_STATE		`isRecurringWeekly()` is `false`
Compliance	`mandatory`		This method must be implemented.
Method	hasLearningObjectives
Description	Tests if this activity unit has associated learning objectives.
Return	`boolean`		`true` if this activity unit has a learning objective, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getLearningObjectiveIds
Description	Gets the overall learning objective `Ids` for this activity unit.
Return	`osid.id.IdList`		`Ids` of the `l` earning objectives
Errors	ILLEGAL_STATE		`hasLearningObjectives()` is `false`
Compliance	`mandatory`		This method is must be implemented.
Method	getLearningObjectives
Description	Gets the overall learning objectives for this activity unit.
Return	`osid.learning.ObjectiveList`		the learning objectives
Errors	ILLEGAL_STATE		`hasLearningObjectives()` is `false`
Errors	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.
Method	getActivityUnitRecord
Description	Gets the activity unit record corresponding to the given `ActivityUnit` record `Type`. This method is used to retrieve an object implementing the requested record. The `activityUnitRecordType` may be the `Type` returned in `getRecordTypes()` or any of its parents in a `Type` hierarchy where `hasRecordType(activityUnitRecordType)` is `true`.
Parameters	`osid.type.Type`	`activityUnitRecordType`	the type of activity unit record to retrieve
Return	`osid.course.records.ActivityUnitRecord`		the activity unit 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.