OSID - osid.course.plan.LessonForm Service Interface Definition

Interface	osid.course.plan.LessonForm
Implements	`osid.OsidRelationshipForm`
Used By	`osid.course.plan.LessonAdminSession`
Description	This is the form for creating and updating `Lessons`. Like all `OsidForm` objects, various data elements may be set here for use in the create and update methods in the `LessonAdminSession`. For each data element that may be set, metadata may be examined to provide display hints or data constraints.
Method	getActivitiesMetadata
Description	Gets the metadata for the activities.
Return	`osid.Metadata`		metadata for the activities
Compliance	`mandatory`		This method must be implemented.
Method	setActivities
Description	Sets the activities.
Parameters	`osid.id.IdList`	`activityIds`	the new activities
Errors	INVALID_ARGUMENT		`activityIds` is invalid
	NO_ACCESS		`activityIds` cannot be modified
	NULL_ARGUMENT		`activityIds` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearActivities
Description	Clears the activities.
Errors	NO_ACCESS		`Metadata.isRequired()` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getPlannedStartTimeMetadata
Description	Gets the metadata for the planned start time.
Return	`osid.Metadata`		metadata for the planned start time
Compliance	`mandatory`		This method must be implemented.
Method	setPlannedStartTime
Description	Sets the planned start time. The time is expressed as a time relative to the starting time of the first activity.
Parameters	`osid.calendaring.Duration`	`time`	the new planned start time
Errors	INVALID_ARGUMENT		`time` is invalid
	NO_ACCESS		`time` cannot be modified
	NULL_ARGUMENT		`time` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearPlannedStartTime
Description	Clears the planned start time.
Errors	NO_ACCESS		`Metadata.isRequired()` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getBegunMetadata
Description	Gets the metadata for the begun flag.
Return	`osid.Metadata`		metadata for the begun flag
Compliance	`mandatory`		This method must be implemented.
Method	setBegun
Description	Sets the begun flag.
Parameters	`boolean`	`begun`	the new begun flag
Errors	INVALID_ARGUMENT		`begun` is invalid
Errors	NO_ACCESS		`begun` cannot be modified
Compliance	`mandatory`		This method must be implemented.
Method	clearBegun
Description	Clears the begun flag.
Errors	NO_ACCESS		`Metadata.isRequired()` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getActualStartTimeMetadata
Description	Gets the metadata for the actual start time. The time is expressed as a time relative to the starting time of the actual starting activity.
Return	`osid.Metadata`		metadata for the actual start time
Compliance	`mandatory`		This method must be implemented.
Method	setActualStartTime
Description	Sets the actual start time.
Parameters	`osid.calendaring.Duration`	`time`	the new actual start time
Errors	INVALID_ARGUMENT		`time` is invalid
	NO_ACCESS		`time` cannot be modified
	NULL_ARGUMENT		`time` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearActualStartTime
Description	Clears the actual start time.
Errors	NO_ACCESS		`Metadata.isRequired()` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getActualStartingActivityMetadata
Description	Gets the metadata for the actual starting activity.
Return	`osid.Metadata`		metadata for the actual starting activity
Compliance	`mandatory`		This method must be implemented.
Method	setActualStartingActivity
Description	Sets the actual starting activity.
Parameters	`osid.id.Id`	`activityId`	the new actual starting activity
Errors	INVALID_ARGUMENT		`activityId` is invalid
	NO_ACCESS		`activityId` cannot be modified
	NULL_ARGUMENT		`activityId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearActualStartingActivity
Description	Clears the actual starting activity.
Errors	NO_ACCESS		`Metadata.isRequired()` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getCompleteMetadata
Description	Gets the metadata for the complete flag.
Return	`osid.Metadata`		metadata for the complete flag
Compliance	`mandatory`		This method must be implemented.
Method	setComplete
Description	Sets the complete flag.
Parameters	`boolean`	`complete`	the new complete flag
Errors	INVALID_ARGUMENT		`complete` is invalid
Errors	NO_ACCESS		`complete` cannot be modified
Compliance	`mandatory`		This method must be implemented.
Method	clearComplete
Description	Clears the complete flag.
Errors	NO_ACCESS		`Metadata.isRequired()` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getSkippedMetadata
Description	Gets the metadata for the skipped flag.
Return	`osid.Metadata`		metadata for the skipped flag
Compliance	`mandatory`		This method must be implemented.
Method	setSkipped
Description	Sets the skipped flag.
Parameters	`boolean`	`skipped`	the new skipped flag
Errors	INVALID_ARGUMENT		`skipped` is invalid
Errors	NO_ACCESS		`skipped` cannot be modified
Compliance	`mandatory`		This method must be implemented.
Method	clearSkipped
Description	Clears the skipped flag.
Errors	NO_ACCESS		`Metadata.isRequired()` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getActualEndTimeMetadata
Description	Gets the metadata for the actual end time.
Return	`osid.Metadata`		metadata for the actual end time
Compliance	`mandatory`		This method must be implemented.
Method	setActualEndTime
Description	Sets the actual end time. The time is expressed as a time relative to the starting time of the ending activity.
Parameters	`osid.calendaring.Duration`	`time`	the new actual end time
Errors	INVALID_ARGUMENT		`time` is invalid
	NO_ACCESS		`time` cannot be modified
	NULL_ARGUMENT		`time` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearActualEndTme
Description	Clears the actual end time.
Errors	NO_ACCESS		`Metadata.isRequired()` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getActualEndingActivityMetadata
Description	Gets the metadata for the actual ending activity.
Return	`osid.Metadata`		metadata for the actual ending activity
Compliance	`mandatory`		This method must be implemented.
Method	setActualEndingActivity
Description	Sets the actual ending activity.
Parameters	`osid.id.Id`	`activityId`	the new actual ending activity
Errors	INVALID_ARGUMENT		`activityId` is invalid
	NO_ACCESS		`activityId` cannot be modified
	NULL_ARGUMENT		`activityId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearActualEndingActivity
Description	Clears the actual ending activity.
Errors	NO_ACCESS		`Metadata.isRequired()` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getActualTimeSpentMetadata
Description	Gets the metadata for the actual time spent.
Return	`osid.Metadata`		metadata for the actual time spent
Compliance	`mandatory`		This method must be implemented.
Method	setActualTimeSpent
Description	Sets the actual time spent.
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	clearActualTimeSpent
Description	Clears the actual time spent.
Errors	NO_ACCESS		`Metadata.isRequired()` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getLessonFormRecord
Description	Gets the `LessonFormRecord` corresponding to the given lesson record `Type`.
Parameters	`osid.type.Type`	`lessonRecordType`	the lesson record type
Return	`osid.course.plan.records.LessonFormRecord`		the lesson form record
Errors	NULL_ARGUMENT		`lessonRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(lessonRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.