Interface Docet

All Superinterfaces:
Browsable, Extensible, Identifiable, OsidObject, OsidRelationship, Temporal
public interface Docet extends OsidRelationship

An Docet is an OsidRelationship between a Module and an ActivityUnit . A Docet may represent a descriptive portion of an in-class lesson plan, an assignment, or an assessment. A Docet may exist at any level of granularity. A Docet may cover an entire Module or there may be lots of Docets specific to fine-grained learning objectives.

  • Method Details

    • getModuleId

      Id getModuleId()
      Gets the Ids of the learning module.
      Returns:
      the learning module Id
      Compliance:
      mandatory - This method must be implemented.

    • getModule

      Module getModule() throws OperationFailedException
      Gets the learning module
      Returns:
      the learning module
      Throws:
      OperationFailedException - unable to complete request
      Compliance:
      mandatory - This method must be implemented.

    • getActivityUnitId

      Id getActivityUnitId()
      Gets the Id of the activity unit.
      Returns:
      the activity unit Id
      Compliance:
      mandatory - This method must be implemented.

    • getActivityUnit

      ActivityUnit getActivityUnit() throws OperationFailedException
      Gets the activity unit.
      Returns:
      the activity unit
      Throws:
      OperationFailedException - unable to complete request
      Compliance:
      mandatory - This method must be implemented.

    • getLearningObjectiveIds

      IdList getLearningObjectiveIds()
      Gets the Ids of the learning objectives.
      Returns:
      the learning objective Ids
      Compliance:
      mandatory - This method must be implemented.

    • getLearningObjectives

      ObjectiveList getLearningObjectives() throws OperationFailedException
      Gets the learning objectives.
      Returns:
      the learning objectives
      Throws:
      OperationFailedException - unable to complete request
      Compliance:
      mandatory - This method must be implemented.

    • isInClass

      boolean isInClass()
      Tests if this Docet occurs within an Activity or it outlines efforts spent outside a convened activity. In class docets can be used to align the estimated duration with the schedule of activities.
      Returns:
      true if this occurs within an activity, false if occurs outside a convened activity
      Compliance:
      mandatory - This method must be implemented.

    • getDuration

      Duration getDuration()
      Gets the estimated duration.
      Returns:
      the duration
      Compliance:
      mandatory - This method must be implemented.

    • hasAssets

      boolean hasAssets()
      Tests if this Docet has a reading materials expressed as Assets .
      Returns:
      true if assets are avilable, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • getAssetIds

      IdList getAssetIds()
      Gets a list of asset materials distributed to the students.
      Returns:
      the asset Ids
      Throws:
      IllegalStateException - hasAssets() is false
      Compliance:
      mandatory - This method must be implemented.

    • getAssets

      AssetList getAssets() throws OperationFailedException
      Gets the assets distributed to the students.
      Returns:
      a list of assets
      Throws:
      IllegalStateException - hasAssets() is false
      OperationFailedException - unable to complete request
      Compliance:
      mandatory - This method must be implemented.

    • hasAssessments

      boolean hasAssessments()
      Tests if this Docet has a quiz or assignment expressed as an Assessment .
      Returns:
      true if assessments are avilable, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • getAssessmentIds

      IdList getAssessmentIds()
      Gets a list of assessments.
      Returns:
      the assessment Ids
      Throws:
      IllegalStateException - hasAssessments() is false
      Compliance:
      mandatory - This method must be implemented.

    • getAssessments

      AssessmentList getAssessments() throws OperationFailedException
      Gets the assessments.
      Returns:
      a list of assessments
      Throws:
      IllegalStateException - hasAssessments() is false
      OperationFailedException - unable to complete request
      Compliance:
      mandatory - This method must be implemented.

    • getDocetRecord

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