Interface Activity

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

An Activity represents a recurring activity of a course offering.

  • Method Details

    • getActivityUnitId

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

    • getActivityUnit

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

    • getCourseOfferingId

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

    • getCourseOffering

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

    • getTermId

      Id getTermId()
      Gets the Id of the Term of this offering.
      Returns:
      the Term Id
      Compliance:
      mandatory - This method must be implemented.

    • getTerm

      Term getTerm() throws OperationFailedException
      Gets the Term of this offering.
      Returns:
      the term
      Throws:
      OperationFailedException - unable to complete request
      Compliance:
      mandatory - This method must be implemented.

    • isImplicit

      boolean isImplicit()
      Tests if this is an implicit or explicit activity.
      Returns:
      true if this is an implicit activity, false if an explicit activity
      Compliance:
      mandatory - This method must be implemented.

    • getScheduleIds

      IdList getScheduleIds()
      Gets the schedule Ids associated with this activity.
      Returns:
      the schedule Ids
      Compliance:
      mandatory - This method must be implemented.

    • getSchedules

      ScheduleList getSchedules() throws OperationFailedException
      Gets the schedules associated with this activity.
      Returns:
      the schedules
      Throws:
      OperationFailedException - unable to complete request
      Compliance:
      mandatory - This method must be implemented.

    • getSupersedingActivityIds

      IdList getSupersedingActivityIds()
      Gets the superseding activity Ids whose sessions override sessions of this activity.
      Returns:
      the superseding activity Ids
      Compliance:
      mandatory - This method must be implemented.

    • getSupersedingActivities

      ActivityList getSupersedingActivities() throws OperationFailedException
      Gets the superseding activities whose sessions that override sessions of this activity.
      Returns:
      the superseding activities
      Throws:
      OperationFailedException - unable to complete request
      Compliance:
      mandatory - This method must be implemented.

    • getSpecificMeetingTimes

      MeetingTimeList getSpecificMeetingTimes()
      Gets the specific meeting times added to this activity.
      Returns:
      a list of specific meeting times
      Compliance:
      mandatory - This method must be implemented.

    • getBlackouts

      DateTimeIntervalList getBlackouts()
      Gets the blackout dates for this activity. Activitiy sessions overlapping with the time intervals do not appear in the series.
      Returns:
      the exceptions to the scheduled activity
      Compliance:
      mandatory - This method must be implemented.

    • getInstructorIds

      IdList getInstructorIds()
      Gets the instructor Ids . If each activity has its own instructor, the headlining instructors may be returned.
      Returns:
      the instructor Ids
      Compliance:
      mandatory - This method must be implemented.

    • getInstructors

      ResourceList getInstructors() throws OperationFailedException
      Gets the instructors. If each activity has its own instructor, the headlining instructors may be returned.
      Returns:
      the sponsors
      Throws:
      OperationFailedException - unable to complete request
      Compliance:
      mandatory - This method must be implemented.

    • requiresRegistration

      boolean requiresRegistration()
      Tests if registration is required.
      Returns:
      true if this is a registration is required, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • getMinimumSeats

      long getMinimumSeats()
      Gets the minimum number of students this activity can have.
      Returns:
      the minimum seats
      Compliance:
      mandatory - This method must be implemented.

    • isSeatingLimited

      boolean isSeatingLimited()
      Tests if seating is limited.
      Returns:
      true if this is a seating is limited, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • getMaximumSeats

      long getMaximumSeats()
      Gets the maximum number of students this activity can accommodate.
      Returns:
      the maximum seats
      Throws:
      IllegalStateException - isSeatingLimited() is false
      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 individual 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.

    • 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 activity 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.