Interface Activity

All Superinterfaces:
Browsable, Extensible, Identifiable, OsidObject, Subjugateable
public interface Activity extends OsidObject, Subjugateable

An Activity represents learning material or other learning activities to meet an objective. An Activity has may relate to a set of Asssts for self learning, recommended Courses to take, or a learning Assessment . The learning Assessment differs from the Objective Assessment in that the latter used to test for proficiency in the Objective .

Generally, an Activity should focus on one of assets, courses, assessments, or some other specific activity related to the objective described or related in the ActivityRecord .

  • Method Details

    • getObjectiveId

      Id getObjectiveId()
      Gets the Id of the related objective.
      Returns:
      the objective Id
      Compliance:
      mandatory - This method must be implemented.

    • getObjective

      Objective getObjective() throws OperationFailedException
      Gets the related objective.
      Returns:
      the related objective
      Throws:
      OperationFailedException - unable to complete request
      Compliance:
      mandatory - This method must be implemented.

    • isAssetBasedActivity

      boolean isAssetBasedActivity()
      Tests if this is an asset based activity.
      Returns:
      true if this activity is based on assets, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • getAssetIds

      IdList getAssetIds()
      Gets the Ids of any assets associated with this activity.
      Returns:
      list of asset Ids
      Throws:
      IllegalStateException - isAssetBasedActivity() is false
      Compliance:
      mandatory - This method must be implemented.

    • getAssets

      AssetList getAssets() throws OperationFailedException
      Gets any assets associated with this activity.
      Returns:
      list of assets
      Throws:
      IllegalStateException - isAssetBasedActivity() is false
      OperationFailedException - unable to complete request
      Compliance:
      mandatory - This method must be implemented.

    • isCourseBasedActivity

      boolean isCourseBasedActivity()
      Tests if this is a course based activity.
      Returns:
      true if this activity is based on courses, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • getCourseIds

      IdList getCourseIds()
      Gets the Ids of any courses associated with this activity.
      Returns:
      list of course Ids
      Throws:
      IllegalStateException - isCourseBasedActivity() is false
      Compliance:
      mandatory - This method must be implemented.

    • getCourses

      CourseList getCourses() throws OperationFailedException
      Gets any courses associated with this activity.
      Returns:
      list of courses
      Throws:
      IllegalStateException - isCourseBasedActivity() is false
      OperationFailedException - unable to complete request
      Compliance:
      mandatory - This method must be implemented.

    • isAssessmentBasedActivity

      boolean isAssessmentBasedActivity()
      Tests if this is an assessment based activity. These assessments are for learning the objective and not for assessing prodiciency in the objective.
      Returns:
      true if this activity is based on assessments, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • getAssessmentIds

      IdList getAssessmentIds()
      Gets the Ids of any assessments associated with this activity.
      Returns:
      list of assessment Ids
      Throws:
      IllegalStateException - isAssessmentBasedActivity() is false
      Compliance:
      mandatory - This method must be implemented.

    • getAssessments

      AssessmentList getAssessments() throws OperationFailedException
      Gets any assessments associated with this activity.
      Returns:
      list of assessments
      Throws:
      IllegalStateException - isAssessmentBasedActivity() is false
      OperationFailedException - unable to complete request
      Compliance:
      mandatory - This method must be implemented.

    • getActivityRecord

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