OSID - osid.course.syllabus.Docet Service Interface Definition

Interface	osid.course.syllabus.Docet
Implements	`osid.OsidRelationship`
Used By	`osid.course.plan.Lesson`
	`osid.course.syllabus.DocetAdminSession`
	`osid.course.syllabus.DocetList`
	`osid.course.syllabus.DocetLookupSession`
Description	An `Docet` is an `OsidRelationship` between a `Module` and an `ActivityUnit` . A `Docet` may represent a descriptive portion of an in-class lesson plan, an assignment, or an assessment. A Docet may exist at any level of granularity. A Docet may cover an entire Module or there may be lots of Docets specific to fine-grained learning objectives.
Method	getModuleId
Description	Gets the `Ids` of the learning module.
Return	`osid.id.Id`		the learning module `Id`
Compliance	`mandatory`		This method must be implemented.
Method	getModule
Description	Gets the learning module
Return	`osid.course.syllabus.Module`		the learning module
Errors	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.
Method	getActivityUnitId
Description	Gets the `Id` of the activity unit.
Return	`osid.id.Id`		the activity unit `Id`
Compliance	`mandatory`		This method must be implemented.
Method	getActivityUnit
Description	Gets the activity unit.
Return	`osid.course.ActivityUnit`		the activity unit
Errors	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.
Method	getLearningObjectiveIds
Description	Gets the `Ids` of the learning objectives.
Return	`osid.id.IdList`		the learning objective `Ids`
Compliance	`mandatory`		This method must be implemented.
Method	getLearningObjectives
Description	Gets the learning objectives.
Return	`osid.learning.ObjectiveList`		the learning objectives
Errors	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.
Method	isInClass
Description	Tests if this `Docet` occurs within an `Activity` or it outlines efforts spent outside a convened activity. In class docets can be used to align the estimated duration with the schedule of activities.
Return	`boolean`		`true` if this occurs within an activity, `false` if occurs outside a convened activity
Compliance	`mandatory`		This method must be implemented.
Method	getDuration
Description	Gets the estimated duration.
Return	`osid.calendaring.Duration`		the duration
Compliance	`mandatory`		This method must be implemented.
Method	hasAssets
Description	Tests if this `Docet` has a reading materials expressed as `Assets`.
Return	`boolean`		`true` if assets are avilable, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getAssetIds
Description	Gets a list of asset materials distributed to the students.
Return	`osid.id.IdList`		the asset `Ids`
Errors	ILLEGAL_STATE		`hasAssets()` is `false`
Compliance	`mandatory`		This method must be implemented.
Method	getAssets
Description	Gets the assets distributed to the students.
Return	`osid.repository.AssetList`		a list of assets
Errors	ILLEGAL_STATE		`hasAssets()` is `false`
Errors	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.
Method	hasAssessments
Description	Tests if this `Docet` has a quiz or assignment expressed as an `Assessment`.
Return	`boolean`		`true` if assessments are avilable, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getAssessmentIds
Description	Gets a list of assessments.
Return	`osid.id.IdList`		the assessment `Ids`
Errors	ILLEGAL_STATE		`hasAssessments()` is `false`
Compliance	`mandatory`		This method must be implemented.
Method	getAssessments
Description	Gets the assessments.
Return	`osid.assessment.AssessmentList`		a list of assessments
Errors	ILLEGAL_STATE		`hasAssessments()` is `false`
Errors	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.
Method	getDocetRecord
Description	Gets the docet record corresponding to the given `Docet` record `Type`.This method must be used to retrieve an object implementing the requested record. The `docetRecordType` may be the `Type` returned in `getRecordTypes()` or any of its parents in a `Type` hierarchy where `hasRecordType(docetRecordType)` is `true`.
Parameters	`osid.type.Type`	`docetRecordType`	the type of docet record to retrieve
Return	`osid.course.syllabus.records.DocetRecord`		the docet record
Errors	NULL_ARGUMENT		`docetRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(docetRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.