Interface AssessmentPart

All Superinterfaces:
Browsable, Containable, Extensible, Identifiable, Operable, OsidObject

public interface AssessmentPart extends OsidObject, Containable, Operable

An AssessmentPart represents a section of an assessment. AssessmentParts may be visible as sections of an assessment or just used to clump together a set of items on which to hang sequence rules.

  • Method Details

    • getAssessmentId

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

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

      boolean hasParentPart()
      Tests if this assessment part belongs to a parent assessment part.
      Returns:
      true if this part has a parent, false if a root
      Compliance:
      mandatory - This method must be implemented.
    • getAssessmentPartId

      Id getAssessmentPartId()
      Gets the parent assessment Id .
      Returns:
      Id of an assessment
      Throws:
      IllegalStateException - hasParentPart() is false
      Compliance:
      mandatory - This method must be implemented.
    • getAssessmentPart

      AssessmentPart getAssessmentPart() throws OperationFailedException
      Gets the parent assessment.
      Returns:
      the parent assessment part
      Throws:
      IllegalStateException - hasParentPart() is false
      OperationFailedException - unable to complete request
      Compliance:
      mandatory - This method must be implemented.
    • isSection

      boolean isSection()
      Tests if this part should be visible as a section in an assessment. If visible, this part will appear to the user as a separate section of the assessment. Typically, a section may not be under a non-sectioned part.
      Returns:
      true if this part is a section, false otherwise
      Compliance:
      mandatory - This method must be implemented.
    • getWeight

      long getWeight()
      Gets an integral weight factor for this assessment part used for scoring. The percentage weight for this part is this weight divided by the sum total of all the weights in the assessment.
      Returns:
      the weight
      Compliance:
      mandatory - This method must be implemented.
    • getAllocatedTime

      Duration getAllocatedTime()
      Gets the allocated time for this part. The allocated time may be used to assign fixed time limits to each item or can be used to estimate the total assessment time.
      Returns:
      allocated time
      Compliance:
      mandatory - This method must be implemented.
    • getChildAssessmentPartIds

      IdList getChildAssessmentPartIds()
      Gets any child assessment part Ids .
      Returns:
      Ids of the child assessment parts
      Compliance:
      mandatory - This method must be implemented.
    • getChildAssessmentParts

      AssessmentPartList getChildAssessmentParts() throws OperationFailedException
      Gets any child assessment parts.
      Returns:
      the child assessment parts
      Throws:
      OperationFailedException - unable to complete request
      Compliance:
      mandatory - This method must be implemented.
    • getAssessmentPartRecord

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