Interface ActivityForm

All Superinterfaces:
Extensible, Identifiable, OsidBrowsableForm, OsidExtensibleForm, OsidForm, OsidIdentifiableForm, OsidObjectForm, OsidSubjugateableForm, Suppliable
All Known Subinterfaces:
ActivityBatchForm
public interface ActivityForm extends OsidObjectForm, OsidSubjugateableForm

This is the form for creating and updating Activities. Like all OsidForms, various data elements may be set here for use in the create and update methods in the ActivityAdminSession. For each data element that may be set, metadata may be examined to provide display hints or data constraints.

  • Method Details

    • getAssetsMetadata

      Metadata getAssetsMetadata()
      Gets the metadata for the assets.
      Returns:
      metadata for the assets
      Compliance:
      mandatory - This method must be implemented.

    • setAssets

      void setAssets(Id[] assetIds)
      Sets the assets.
      Parameters:
      assetIds - the asset Ids
      Throws:
      InvalidArgumentException - assetIds is invalid
      NullArgumentException - assetIds is null
      NoAccessException - Metadata.isReadOnly() is true
      Compliance:
      mandatory - This method must be implemented.

    • clearAssets

      void clearAssets()
      Clears the assets.
      Throws:
      NoAccessException - Metadata.isRequired() or Metadata.isReadOnly() is true
      Compliance:
      mandatory - This method must be implemented.

    • getCoursesMetadata

      Metadata getCoursesMetadata()
      Gets the metadata for the courses.
      Returns:
      metadata for the courses
      Compliance:
      mandatory - This method must be implemented.

    • setCourses

      void setCourses(Id[] courseIds)
      Sets the courses.
      Parameters:
      courseIds - the course Ids
      Throws:
      InvalidArgumentException - courseIds is invalid
      NullArgumentException - courseIds is null
      NoAccessException - Metadata.isReadOnly() is true
      Compliance:
      mandatory - This method must be implemented.

    • clearCourses

      void clearCourses()
      Clears the courses.
      Throws:
      NoAccessException - Metadata.isRequired() or Metadata.isReadOnly() is true
      Compliance:
      mandatory - This method must be implemented.

    • getAssessmentsMetadata

      Metadata getAssessmentsMetadata()
      Gets the metadata for the assessments.
      Returns:
      metadata for the assessments
      Compliance:
      mandatory - This method must be implemented.

    • setAssessments

      void setAssessments(Id[] assessmentIds)
      Sets the assessments.
      Parameters:
      assessmentIds - the assessment Ids
      Throws:
      InvalidArgumentException - assessmentIds is invalid
      NullArgumentException - assessmentIds is null
      NoAccessException - Metadata.isReadOnly() is true
      Compliance:
      mandatory - This method must be implemented.

    • clearAssessments

      void clearAssessments()
      Clears the assessments.
      Throws:
      NoAccessException - Metadata.isRequired() or Metadata.isReadOnly() is true
      Compliance:
      mandatory - This method must be implemented.

    • getActivityFormRecord

      ActivityFormRecord getActivityFormRecord(Type activityRecordType) throws OperationFailedException
      Gets the ActivityFormRecord corresponding to the given activity record Type.
      Parameters:
      activityRecordType - the activity record type
      Returns:
      the activity form record
      Throws:
      NullArgumentException - activityRecordType is null
      OperationFailedException - unable to complete request
      UnsupportedException - hasRecordType(activityRecordType) is false
      Compliance:
      mandatory - This method must be implemented.