Interface ActivityUnit

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

An ActivityUnit represents a canonical learning unit. A canonical learning unit describes a kind of activity that will be offered and is used for curriculum planning.

Like all OsidObjects, ActivityUnit is managed by its OsidSessions and may not be accessed by concurrent processing threads.

  • Method Details

    • getCourseId

      Id getCourseId()
      Gets the canonical course Id associated with this activity.
      Returns:
      the course Id
      Compliance:
      mandatory - This method must be implemented.

    • getCourse

      Course getCourse() throws OperationFailedException
      Gets the canonical course associated with this activity.
      Returns:
      the course
      Throws:
      OperationFailedException - unable to complete request
      Compliance:
      mandatory - This method must be implemented.

    • getTotalTargetEffort

      Duration getTotalTargetEffort()
      Gets the total time required for this activity.
      Returns:
      the total effort
      Compliance:
      mandatory - This method must be implemented.

    • isContact

      boolean isContact()
      Tests if this is a contact activity.
      Returns:
      true if this is a contact activity, false if an independent activity
      Compliance:
      mandatory - This method must be implemented.

    • getTotalTargetContactTime

      Duration getTotalTargetContactTime()
      Gets the total contact time for this activity.
      Returns:
      the total effort
      Compliance:
      mandatory - This method must be implemented.

    • getTotalTargetIndividualEffort

      Duration getTotalTargetIndividualEffort()
      Gets the total indivudal time required for this activity.
      Returns:
      the total individual effort
      Compliance:
      mandatory - This method must be implemented.

    • isRecurringWeekly

      boolean isRecurringWeekly()
      Tests if this activity is recurring.
      Returns:
      true if this activity is recurring, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • getWeeklyEffort

      Duration getWeeklyEffort()
      Gets the time required for this recurring effort on a weekly basis.
      Returns:
      the weekly time
      Throws:
      IllegalStateException - isRecurringWeekly() is false
      Compliance:
      mandatory - This method must be implemented.

    • getWeeklyContactTime

      Duration getWeeklyContactTime()
      Gets the weekly contact time for ths activity.
      Returns:
      the weekly time
      Throws:
      IllegalStateException - isRecurringWeekly() is false
      Compliance:
      mandatory - This method must be implemented.

    • getWeeklyIndividualEffort

      Duration getWeeklyIndividualEffort()
      Gets the weekly individual time for ths activity.
      Returns:
      the weekly time
      Throws:
      IllegalStateException - isRecurringWeekly() is false
      Compliance:
      mandatory - This method must be implemented.

    • hasLearningObjectives

      boolean hasLearningObjectives()
      Tests if this activity unit has associated learning objectives.
      Returns:
      true if this activity unit has a learning objective, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • getLearningObjectiveIds

      IdList getLearningObjectiveIds()
      Gets the overall learning objective Ids for this activity unit.
      Returns:
      Ids of the l earning objectives
      Throws:
      IllegalStateException - hasLearningObjectives() is false
      Compliance:
      mandatory - This method must be implemented.

    • getLearningObjectives

      ObjectiveList getLearningObjectives() throws OperationFailedException
      Gets the overall learning objectives for this activity unit.
      Returns:
      the learning objectives
      Throws:
      IllegalStateException - hasLearningObjectives() is false
      OperationFailedException - unable to complete request
      Compliance:
      mandatory - This method must be implemented.

    • getActivityUnitRecord

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