OSID - osid.learning.Activity Service Interface Definition

Interface	osid.learning.Activity
Implements	`osid.OsidObject`
Implements	`osid.Subjugateable`
Used By	`osid.learning.ActivityAdminSession`
	`osid.learning.ActivityList`
	`osid.learning.ActivityLookupSession`
Description	An `Activity` represents learning material or other learning activities to meet an objective. An Activity has may relate to a set of `Asssts` for self learning, recommended `Courses` to take, or a learning `Assessment`. The learning `Assessment` differs from the `Objective` `Assessment` in that the latter used to test for proficiency in the `Objective`. Generally, an `Activity` should focus on one of assets, courses, assessments, or some other specific activity related to the objective described or related in the `ActivityRecord`.
Method	getObjectiveId
Description	Gets the `Id` of the related objective.
Return	`osid.id.Id`		the objective `Id`
Compliance	`mandatory`		This method must be implemented.
Method	getObjective
Description	Gets the related objective.
Return	`osid.learning.Objective`		the related objective
Errors	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.
Method	isAssetBasedActivity
Description	Tests if this is an asset based activity.
Return	`boolean`		`true` if this activity is based on assets, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getAssetIds
Description	Gets the `Ids` of any assets associated with this activity.
Return	`osid.id.IdList`		list of asset `Ids`
Errors	ILLEGAL_STATE		`isAssetBasedActivity()` is `false`
Compliance	`mandatory`		This method must be implemented.
Method	getAssets
Description	Gets any assets associated with this activity.
Return	`osid.repository.AssetList`		list of assets
Errors	ILLEGAL_STATE		`isAssetBasedActivity()` is `false`
Errors	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.
Method	isCourseBasedActivity
Description	Tests if this is a course based activity.
Return	`boolean`		`true` if this activity is based on courses, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getCourseIds
Description	Gets the `Ids` of any courses associated with this activity.
Return	`osid.id.IdList`		list of course `Ids`
Errors	ILLEGAL_STATE		`isCourseBasedActivity()` is `false`
Compliance	`mandatory`		This method must be implemented.
Method	getCourses
Description	Gets any courses associated with this activity.
Return	`osid.course.CourseList`		list of courses
Errors	ILLEGAL_STATE		`isCourseBasedActivity()` is `false`
Errors	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.
Method	isAssessmentBasedActivity
Description	Tests if this is an assessment based activity. These assessments are for learning the objective and not for assessing prodiciency in the objective.
Return	`boolean`		`true` if this activity is based on assessments, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getAssessmentIds
Description	Gets the `Ids` of any assessments associated with this activity.
Return	`osid.id.IdList`		list of assessment `Ids`
Errors	ILLEGAL_STATE		`isAssessmentBasedActivity()` is `false`
Compliance	`mandatory`		This method must be implemented.
Method	getAssessments
Description	Gets any assessments associated with this activity.
Return	`osid.assessment.AssessmentList`		list of assessments
Errors	ILLEGAL_STATE		`isAssessmentBasedActivity()` is `false`
Errors	OPERATION_FAILED		unable to complete request
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 the record to retrieve
Return	`osid.learning.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.