Operation Contracts - dnstremba/recall-enhancer GitHub Wiki

Operation Contracts

Contract CO1: startReviewSession

Operation: startReviewSession()
Cross References: Uses Cases: Recall Items
Preconditions: None.
Postconditions:
  • A ReviewSession rs was created

Contract CO2: completeRepetition

Operation: completeRepetition(repetitionId: RepetitionId, responseRate: integer)
Cross References: Uses Cases: Recall Items
Preconditions: There is review session underway.
Postconditions:
  • A Repetition completedRepetition was associated with the current ReviewSession based on repetitionId match
  • A Repetition createdRepetition was created
  • createdRepetition.responseRate became responseRate
⚠️ **GitHub.com Fallback** ⚠️