OSID - osid.course.Activity Service Interface Definition

Interface	osid.course.Activity
Implements	`osid.OsidRelationship`
Implements	`osid.Subjugateable`
Description	An `Activity` represents a recurring activity of a course offering.
Method	getActivityUnitId
Description	Gets the activity unit `Id` associated with this activity.
Return	`osid.id.Id`		the activity unit `Id`
Compliance	`mandatory`		This method must be implemented.
Method	getActivityUnit
Description	Gets the activity unit associated with this activity.
Return	`osid.course.ActivityUnit`		the activity unit
Errors	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.
Method	getCourseOfferingId
Description	Gets the course offering `Id` associated with this activity.
Return	`osid.id.Id`		the course offering `Id`
Compliance	`mandatory`		This method must be implemented.
Method	getCourseOffering
Description	Gets the course offering associated with this activity.
Return	`osid.course.CourseOffering`		the course offering
Errors	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.
Method	getTermId
Description	Gets the `Id` of the `Term` of this offering.
Return	`osid.id.Id`		the `Term` `Id`
Compliance	`mandatory`		This method must be implemented.
Method	getTerm
Description	Gets the `Term` of this offering.
Return	`osid.course.Term`		the term
Errors	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.
Method	isImplicit
Description	Tests if this is a an implicit or explicit activity.
Return	`boolean`		`true` if this is an implicit activity, `false` if an explicit activity
Compliance	`mandatory`		This method must be implemented.
Method	getScheduleIds
Description	Gets the schedule `Ids` associated with this activity.
Return	`osid.id.IdList`		the schedule `Ids`
Compliance	`mandatory`		This method must be implemented.
Method	getSchedules
Description	Gets the schedules associated with this activity.
Return	`osid.calendaring.ScheduleList`		the schedules
Errors	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.
Method	getSupersedingActivityIds
Description	Gets the superseding activity `Ids` whose sessions override sessions of this activity.
Return	`osid.id.IdList`		the superseding activity `Ids`
Compliance	`mandatory`		This method must be implemented.
Method	getSupersedingActivities
Description	Gets the superseding activities whose sessions that override sessions of this activity.
Return	`osid.course.ActivityList`		the superseding activities
Errors	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.
Method	getSpecificMeetingTimes
Description	Gets the specific meeting times added to this activity.
Return	`osid.calendaring.MeetingTimeList`		a list of specific meeting times
Compliance	`mandatory`		This method must be implemented.
Method	getBlackouts
Description	Gets the blackout dates for this activity. Activitiy sessions overlapping with the time intervals do not appear in the series.
Return	`osid.calendaring.DateTimeIntervalList`		the exceptions to the scheduled activity
Compliance	`mandatory`		This method must be implemented.
Method	getInstructorIds
Description	Gets the instructor `Ids.` If each activity has its own instructor, the headlining instructors may be returned.
Return	`osid.id.IdList`		the instructor `Ids`
Compliance	`mandatory`		This method must be implemented.
Method	getInstructors
Description	Gets the instructors. If each activity has its own instructor, the headlining instructors may be returned.
Return	`osid.resource.ResourceList`		the sponsors
Errors	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.
Method	requiresRegistration
Description	Tests if registration is required.
Return	`boolean`		`true` if this is a registration is required, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getMinimumSeats
Description	Gets the minimum number of students this activity can have.
Return	`cardinal`		the minimum seats
Compliance	`mandatory`		This method must be implemented.
Method	isSeatingLimited
Description	Tests if seating is limited.
Return	`boolean`		`true` if this is a seating is limited, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getMaximumSeats
Description	Gets the maximum number of students this activity can accommodate.
Return	`cardinal`		the maximum seats
Errors	ILLEGAL_STATE		`isSeatingLimited()` is `false`
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 individual 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	getActivityRecord
Description	Gets the activity record corresponding to the given `Activity` record `Type.` This method is used to retrieve an object implementing the requested record. The `activityRecordType` may be the `Type` returned in `getRecordTypes()` or any of its parents in a `Type` hierarchy where `hasRecordType(activityRecordType)` is `true` .
Parameters	`osid.type.Type`	`activityRecordType`	the type of activity record to retrieve
Return	`osid.course.records.ActivityRecord`		the activity 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.