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

Interface	osid.course.syllabus.DocetForm
Implements	`osid.OsidRelationshipForm`
Implemented By	`osid.course.syllabus.batch.DocetBatchForm`
Used By	`osid.course.syllabus.DocetAdminSession`
Description	This is the form for creating and updating `Docets`. Like all `OsidForm` objects, various data elements may be set here for use in the create and update methods in the `DocetAdminSession`. For each data element that may be set, metadata may be examined to provide display hints or data constraints.
Method	getLearningObjectivesMetadata
Description	Gets the metadata for the learning obectives.
Return	`osid.Metadata`		metadata for the objectives
Compliance	`mandatory`		This method must be implemented.
Method	setLearningObjectives
Description	Sets the learning objectives.
Parameters	`osid.id.IdList`	`objectiveIds`	the new objectives
Errors	INVALID_ARGUMENT		`objectiveIds` is invalid
	NO_ACCESS		`objectiveIds` cannot be modified
	NULL_ARGUMENT		`objectiveIds` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearLearningObjectives
Description	Clears the in class flag.
Errors	NO_ACCESS		`Metadata.isRequired()` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getInClassMetadata
Description	Gets the metadata for the in class flag.
Return	`osid.Metadata`		metadata for the in class flag
Compliance	`mandatory`		This method must be implemented.
Method	setInClass
Description	Sets the in class flag.
Parameters	`boolean`	`inClass`	the new in class flag
Errors	INVALID_ARGUMENT		`inClass` is invalid
Errors	NO_ACCESS		`inClass` cannot be modified
Compliance	`mandatory`		This method must be implemented.
Method	clearInClass
Description	Clears the in class flag.
Errors	NO_ACCESS		`Metadata.isRequired()` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getDurationMetadata
Description	Gets the metadata for the duration.
Return	`osid.Metadata`		metadata for the duration
Compliance	`mandatory`		This method must be implemented.
Method	setDuration
Description	Sets the duration.
Parameters	`osid.calendaring.Duration`	`duration`	the new duration
Errors	INVALID_ARGUMENT		`duration` is invalid
	NO_ACCESS		`duration` cannot be modified
	NULL_ARGUMENT		`duration` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearDuration
Description	Clears the duration.
Errors	NO_ACCESS		`Metadata.isRequired()` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getAssetsMetadata
Description	Gets the metadata for the assets.
Return	`osid.Metadata`		metadata for the assets
Compliance	`mandatory`		This method must be implemented.
Method	setAssets
Description	Sets the assets.
Parameters	`osid.id.IdList`	`assetIds`	the new assets
Errors	INVALID_ARGUMENT		`assetIds` is invalid
	NO_ACCESS		`assetIds` cannot be modified
	NULL_ARGUMENT		`assetIds` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearAssets
Description	Clears the assets.
Errors	NO_ACCESS		`Metadata.isRequired()` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getAssessmentsMetadata
Description	Gets the metadata for the assessments.
Return	`osid.Metadata`		metadata for the assessments
Compliance	`mandatory`		This method must be implemented.
Method	setAssessments
Description	Sets the assessments.
Parameters	`osid.id.IdList`	`assessmentIds`	the new assessments
Errors	INVALID_ARGUMENT		`assessmentIds` is invalid
	NO_ACCESS		`assessmentIds` cannot be modified
	NULL_ARGUMENT		`assessmentIds` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearAssessments
Description	Clears the assessments.
Errors	NO_ACCESS		`Metadata.isRequired()` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getDocetFormRecord
Description	Gets the `DocetFormRecord` corresponding to the given docet record `Type`.
Parameters	`osid.type.Type`	`docetRecordType`	the docet record type
Return	`osid.course.syllabus.records.DocetFormRecord`		the docet form 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.