Module course_state

Expand description

A course’s editable content held in memory: as published, or as the user sees it with their open changeset laid over it.

Modules§

CourseState: Every editable entity of one course.
CourseView: The published course and the user’s staged view of it.
ExerciseDeadline: What decides an exercise’s deadline, held for every exercise of a course’s pages so that risk sees deadlines without the ExerciseRecords loaded.
ExerciseRecord: What agents may edit of an exercise, and what identifies its tasks and review settings. The exercise itself is stored in the full PageSnapshot of its page.
ExerciseTaskRecord: One task of an ExerciseRecord.
PageRecord: A page’s structure fields and blocks; exercises stay in the full PageSnapshot.
StateChanges: What changed between two course states. Pages are listed by id: their full snapshots hold exercises, which only the database has.

CourseParts: Which parts of a course a tool reads; the course settings are always there, the other parts left out stay empty.
ExerciseEditError: Why an ExerciseRecord couldn’t be applied.
ExerciseReviewConfig: Which peer and self review settings an exercise uses.
PublishBlocker: A rule publishing relies on that a course state breaks. Pages, chapters and modules are named as the state has them.
ReviewConfigKind: Which review settings an exercise uses.
StagedEntity: The state one entity has after an agent write call.

load_live_course: Loads the parts of the course as published.
load_view: Loads the parts of the published course and the user’s open changeset for it.
review_instructions_for_storage: Review instructions as the CMS stores them: None for no blocks or only empty paragraphs.