OSID Logo
OSID Specifications
course plan package
Version 3.0.0
Release Candidate Preview
Interfaceosid.course.plan.LessonForm
Implementsosid.OsidRelationshipForm
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.

MethodgetActivitiesMetadata
Description

Gets the metadata for the activities.

Returnosid.Metadatametadata for the activities
CompliancemandatoryThis method must be implemented.
MethodsetActivities
Description

Sets the activities.

Parametersosid.id.IdListactivityIdsthe new activities
ErrorsINVALID_ARGUMENT activityIds is invalid
NO_ACCESS activityIds cannot be modified
NULL_ARGUMENT activityIds is null
CompliancemandatoryThis method must be implemented.
MethodclearActivities
Description

Clears the activities.

ErrorsNO_ACCESS Metadata.isRequired() or Metadata.isReadOnly() is true
CompliancemandatoryThis method must be implemented.
MethodgetPlannedStartTimeMetadata
Description

Gets the metadata for the planned start time.

Returnosid.Metadatametadata for the planned start time
CompliancemandatoryThis method must be implemented.
MethodsetPlannedStartTime
Description

Sets the planned start time. The time is expressed as a time relative to the starting time of the first activity.

Parametersosid.calendaring.Durationtimethe new planned start time
ErrorsINVALID_ARGUMENT time is invalid
NO_ACCESS time cannot be modified
NULL_ARGUMENT time is null
CompliancemandatoryThis method must be implemented.
MethodclearPlannedStartTime
Description

Clears the planned start time.

ErrorsNO_ACCESS Metadata.isRequired() or Metadata.isReadOnly() is true
CompliancemandatoryThis method must be implemented.
MethodgetBegunMetadata
Description

Gets the metadata for the begun flag.

Returnosid.Metadatametadata for the begun flag
CompliancemandatoryThis method must be implemented.
MethodsetBegun
Description

Sets the begun flag.

Parametersbooleanbegunthe new begun flag
ErrorsINVALID_ARGUMENT begun is invalid
NO_ACCESS begun cannot be modified
CompliancemandatoryThis method must be implemented.
MethodclearBegun
Description

Clears the begun flag.

ErrorsNO_ACCESS Metadata.isRequired() or Metadata.isReadOnly() is true
CompliancemandatoryThis method must be implemented.
MethodgetActualStartTimeMetadata
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.

Returnosid.Metadatametadata for the actual start time
CompliancemandatoryThis method must be implemented.
MethodsetActualStartTime
Description

Sets the actual start time.

Parametersosid.calendaring.Durationtimethe new actual start time
ErrorsINVALID_ARGUMENT time is invalid
NO_ACCESS time cannot be modified
NULL_ARGUMENT time is null
CompliancemandatoryThis method must be implemented.
MethodclearActualStartTime
Description

Clears the actual start time.

ErrorsNO_ACCESS Metadata.isRequired() or Metadata.isReadOnly() is true
CompliancemandatoryThis method must be implemented.
MethodgetActualStartingActivityMetadata
Description

Gets the metadata for the actual starting activity.

Returnosid.Metadatametadata for the actual starting activity
CompliancemandatoryThis method must be implemented.
MethodsetActualStartingActivity
Description

Sets the actual starting activity.

Parametersosid.id.IdactivityIdthe new actual starting activity
ErrorsINVALID_ARGUMENT activityId is invalid
NO_ACCESS activityId cannot be modified
NULL_ARGUMENT activityId is null
CompliancemandatoryThis method must be implemented.
MethodclearActualStartingActivity
Description

Clears the actual starting activity.

ErrorsNO_ACCESS Metadata.isRequired() or Metadata.isReadOnly() is true
CompliancemandatoryThis method must be implemented.
MethodgetCompleteMetadata
Description

Gets the metadata for the complete flag.

Returnosid.Metadatametadata for the complete flag
CompliancemandatoryThis method must be implemented.
MethodsetComplete
Description

Sets the complete flag.

Parametersbooleancompletethe new complete flag
ErrorsINVALID_ARGUMENT complete is invalid
NO_ACCESS complete cannot be modified
CompliancemandatoryThis method must be implemented.
MethodclearComplete
Description

Clears the complete flag.

ErrorsNO_ACCESS Metadata.isRequired() or Metadata.isReadOnly() is true
CompliancemandatoryThis method must be implemented.
MethodgetSkippedMetadata
Description

Gets the metadata for the skipped flag.

Returnosid.Metadatametadata for the skipped flag
CompliancemandatoryThis method must be implemented.
MethodsetSkipped
Description

Sets the skipped flag.

Parametersbooleanskippedthe new skipped flag
ErrorsINVALID_ARGUMENT skipped is invalid
NO_ACCESS skipped cannot be modified
CompliancemandatoryThis method must be implemented.
MethodclearSkipped
Description

Clears the skipped flag.

ErrorsNO_ACCESS Metadata.isRequired() or Metadata.isReadOnly() is true
CompliancemandatoryThis method must be implemented.
MethodgetActualEndTimeMetadata
Description

Gets the metadata for the actual end time.

Returnosid.Metadatametadata for the actual end time
CompliancemandatoryThis method must be implemented.
MethodsetActualEndTime
Description

Sets the actual end time. The time is expressed as a time relative to the starting time of the ending activity.

Parametersosid.calendaring.Durationtimethe new actual end time
ErrorsINVALID_ARGUMENT time is invalid
NO_ACCESS time cannot be modified
NULL_ARGUMENT time is null
CompliancemandatoryThis method must be implemented.
MethodclearActualEndTme
Description

Clears the actual end time.

ErrorsNO_ACCESS Metadata.isRequired() or Metadata.isReadOnly() is true
CompliancemandatoryThis method must be implemented.
MethodgetActualEndingActivityMetadata
Description

Gets the metadata for the actual ending activity.

Returnosid.Metadatametadata for the actual ending activity
CompliancemandatoryThis method must be implemented.
MethodsetActualEndingActivity
Description

Sets the actual ending activity.

Parametersosid.id.IdactivityIdthe new actual ending activity
ErrorsINVALID_ARGUMENT activityId is invalid
NO_ACCESS activityId cannot be modified
NULL_ARGUMENT activityId is null
CompliancemandatoryThis method must be implemented.
MethodclearActualEndingActivity
Description

Clears the actual ending activity.

ErrorsNO_ACCESS Metadata.isRequired() or Metadata.isReadOnly() is true
CompliancemandatoryThis method must be implemented.
MethodgetActualTimeSpentMetadata
Description

Gets the metadata for the actual time spent.

Returnosid.Metadatametadata for the actual time spent
CompliancemandatoryThis method must be implemented.
MethodsetActualTimeSpent
Description

Sets the actual time spent.

Parametersosid.calendaring.Durationdurationthe new duration
ErrorsINVALID_ARGUMENT duration is invalid
NO_ACCESS duration cannot be modified
NULL_ARGUMENT duration is null
CompliancemandatoryThis method must be implemented.
MethodclearActualTimeSpent
Description

Clears the actual time spent.

ErrorsNO_ACCESS Metadata.isRequired() or Metadata.isReadOnly() is true
CompliancemandatoryThis method must be implemented.
MethodgetLessonFormRecord
Description

Gets the LessonFormRecord corresponding to the given lesson record Type.

Parametersosid.type.TypelessonRecordTypethe lesson record type
Returnosid.course.plan.records.LessonFormRecordthe lesson form record
ErrorsNULL_ARGUMENT lessonRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(lessonRecordType) is false
CompliancemandatoryThis method must be implemented.