Guidelines

Guidelines

Guidelines can be inherited. Therefore they extend the abstract concept of scoped inheritance. The ScopedInheritanceEntity is defined as follows:

declare interface ScopedInheritanceEntity extends AbstractEntity {
  key: string

  scope: {
    [foreignId: string]: string[]
  }

  details: {
    active?: boolean
    [moreProperties: string]: any
  }
}

declare interface ScopedInheritanceGuidelineAndTags<
  DetailsType extends ScopedInheritanceGuidelineAndTagsDetails = ScopedInheritanceGuidelineAndTagsDetails
> extends ScopedInheritanceEntity {
  scope: {
    topicIds: [string | '']
    courseIds: [string | '']
  }

  details: DetailsType
}

declare interface ScopedInheritanceGuidelineAndTagsDetails {
  active?: boolean
  label?: string
  description?: string
}

Guidelines are defined as follows. Guidelines that are notAssessable won't show up in a feedback view. They are only used for clearing things up for the users. A non assessable guideline for example is an example question.
The number is only for sorting purposes.

declare interface GuidelineDetails
  extends ScopedInheritanceGuidelineAndTagsDetails {
  notAssessable?: boolean
  number?: number
}

interface Guideline
  extends ScopedInheritanceGuidelineAndTags<GuidelineDetails> {}