Interface SequenceRule

All Superinterfaces:
Browsable, Extensible, Identifiable, Operable, OsidObject, OsidRule
public interface SequenceRule extends OsidRule

A SequenceRule defines the ordering of AssessmentParts .

  • Method Details

    • getAssessmentPartId

      Id getAssessmentPartId()
      Gets the assessment part Id to which this rule belongs.
      Returns:
      Id of an assessment part
      Compliance:
      mandatory - This method must be implemented.

    • getAssessmentPart

      AssessmentPart getAssessmentPart() throws OperationFailedException
      Gets the assessment part to which this rule belongs.
      Returns:
      an assessment part
      Throws:
      OperationFailedException - unable to complete request
      Compliance:
      mandatory - This method must be implemented.

    • getNextAssessmentPartId

      Id getNextAssessmentPartId()
      Gets the next assessment part Id for success of this rule.
      Returns:
      Id of an assessment part
      Compliance:
      mandatory - This method must be implemented.

    • getNextAssessmentPart

      AssessmentPart getNextAssessmentPart() throws OperationFailedException
      Gets the next assessment part for success of this rule.
      Returns:
      an assessment part
      Throws:
      OperationFailedException - unable to complete request
      Compliance:
      mandatory - This method must be implemented.

    • getMinimumScore

      long getMinimumScore()
      Gets the minimum score expressed as an integer (0-100) for this rule.
      Returns:
      minimum score
      Compliance:
      mandatory - This method must be implemented.

    • getMaximumScore

      long getMaximumScore()
      Gets the maximum score expressed as an integer (0-100) for this rule.
      Returns:
      maximum score
      Compliance:
      mandatory - This method must be implemented.

    • isCumulative

      boolean isCumulative()
      Tests if the score is applied to all previous assessment parts.
      Returns:
      true if the score is applied to all previous assessment parts, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • getAppliedAssessmentPartIds

      IdList getAppliedAssessmentPartIds()
      Qualifies isCumulative() to apply to a specific list of assessment parts. If isCumulative() is true , this method may return an empty list to mean all previous assessment parts.
      Returns:
      list of assessment parts
      Throws:
      IllegalStateException - isCumulative() is false
      Compliance:
      mandatory - This method must be implemented.

    • getAppliedAssessmentParts

      AssessmentPartList getAppliedAssessmentParts() throws OperationFailedException
      Qualifies isCumulative() to apply to a specific list of assessment parts. If isCumulative() is true , this method may return an empty list to mean all previous assessment parts.
      Returns:
      list of assessment parts
      Throws:
      IllegalStateException - isCumulative() is false
      OperationFailedException - unable to complete request
      Compliance:
      mandatory - This method must be implemented.

    • getSequenceRuleRecord

      SequenceRuleRecord getSequenceRuleRecord(Type sequenceRuleRecordType) throws OperationFailedException
      Gets the assessment sequence rule record corresponding to the given SequenceRule record Type . This method is used to retrieve an object implementing the requested record. The sequenceRuleRecordType may be the Type returned in getRecordTypes() or any of its parents in a Type hierarchy where hasRecordType(sequenceRuleRecordType) is true .
      Parameters:
      sequenceRuleRecordType - the type of the record to retrieve
      Returns:
      the assessment sequence rule record
      Throws:
      NullArgumentException - sequenceRuleRecordType is null
      OperationFailedException - unable to complete request
      UnsupportedException - hasRecordType(sequenceRuleRecordType) is false
      Compliance:
      mandatory - This method must be implemented.