Interface ActivityForm

All Superinterfaces:
Extensible, Identifiable, OsidBrowsableForm, OsidExtensibleForm, OsidForm, OsidIdentifiableForm, OsidObjectForm, OsidRelationshipForm, OsidSubjugateableForm, OsidTemporalForm, Suppliable
All Known Subinterfaces:
ActivityBatchForm
public interface ActivityForm extends OsidRelationshipForm, 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

    • getInstructorsMetadata

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

    • setInstructors

      void setInstructors(Id[] resourceIds)
      Sets the instructors.
      Parameters:
      resourceIds - the new instructors
      Throws:
      InvalidArgumentException - instructorIds is invalid
      NoAccessException - Metadata.isReadOnly() is true
      NullArgumentException - instructorIds is null
      Compliance:
      mandatory - This method must be implemented.

    • clearInstructors

      void clearInstructors()
      Removes the instructors.
      Throws:
      NoAccessException - Metadata.isRequired() is true or Metadata.isReadOnly() is true
      Compliance:
      mandatory - This method must be implemented.

    • getMinimumSeatsMetadata

      Metadata getMinimumSeatsMetadata()
      Gets the metadata for the minimum seats.
      Returns:
      metadata for the minimum seats
      Compliance:
      mandatory - This method must be implemented.

    • setMinimumSeats

      void setMinimumSeats(long seats)
      Sets the minimum seating count.
      Parameters:
      seats - the new minimum seats
      Throws:
      InvalidArgumentException - seats is invalid
      NoAccessException - Metadata.isReadOnly() is true
      Compliance:
      mandatory - This method must be implemented.

    • clearMinimumSeats

      void clearMinimumSeats()
      Removes the minimum seats.
      Throws:
      NoAccessException - Metadata.isRequired() is true or Metadata.isReadOnly() is true
      Compliance:
      mandatory - This method must be implemented.

    • getMaximumSeatsMetadata

      Metadata getMaximumSeatsMetadata()
      Gets the metadata for the maximum seats.
      Returns:
      metadata for the maximum seats
      Compliance:
      mandatory - This method must be implemented.

    • setMaximumSeats

      void setMaximumSeats(long seats)
      Sets the maximum seating count.
      Parameters:
      seats - the new maximum seats
      Throws:
      InvalidArgumentException - seats is invalid
      NoAccessException - Metadata.isReadOnly() is true
      Compliance:
      mandatory - This method must be implemented.

    • clearMaximumSeats

      void clearMaximumSeats()
      Removes the maximum seats.
      Throws:
      NoAccessException - Metadata.isRequired() is true or Metadata.isReadOnly() is true
      Compliance:
      mandatory - This method must be implemented.

    • getTotalEffortMatadata

      Metadata getTotalEffortMatadata()
      Gets the metadata for the total effort. The amount may be calculated from the other data.
      Returns:
      metadata for the total effort
      Compliance:
      mandatory - This method must be implemented.

    • setTotalTargetEffort

      void setTotalTargetEffort(Duration time)
      Sets the total effort.
      Parameters:
      time - the new total effort
      Throws:
      InvalidArgumentException - time is invalid
      NoAccessException - Metadata.isReadOnly() is true
      NullArgumentException - time is null
      Compliance:
      mandatory - This method must be implemented.

    • clearTotalTargetEffort

      void clearTotalTargetEffort()
      Removes the total effort.
      Throws:
      NoAccessException - Metadata.isRequired() is true or Metadata.isReadOnly() is true
      Compliance:
      mandatory - This method must be implemented.

    • getContactMetadata

      Metadata getContactMetadata()
      Gets the metadata for the contact flag.
      Returns:
      metadata for the contact
      Compliance:
      mandatory - This method must be implemented.

    • setContact

      void setContact(boolean contact)
      Sets the contact flag.
      Parameters:
      contact - the new contact flag
      Throws:
      InvalidArgumentException - contact is invalid
      NoAccessException - Metadata.isReadOnly() is true
      Compliance:
      mandatory - This method must be implemented.

    • clearContact

      void clearContact()
      Removes the contact flag.
      Throws:
      NoAccessException - Metadata.isRequired() is true or Metadata.isReadOnly() is true
      Compliance:
      mandatory - This method must be implemented.

    • getTotalTargetContactTimeMetadata

      Metadata getTotalTargetContactTimeMetadata()
      Gets the metadata for the total contact time.
      Returns:
      metadata for the total contact time
      Compliance:
      mandatory - This method must be implemented.

    • setTotalTargetContactTime

      void setTotalTargetContactTime(Duration time)
      Sets the total contact time.
      Parameters:
      time - the new total contact time
      Throws:
      InvalidArgumentException - time is invalid
      NoAccessException - Metadata.isReadOnly() is true
      NullArgumentException - time is null
      Compliance:
      mandatory - This method must be implemented.

    • clearTotalTargetContactTime

      void clearTotalTargetContactTime()
      Removes the total contact time.
      Throws:
      NoAccessException - Metadata.isRequired() is true or Metadata.isReadOnly() is true
      Compliance:
      mandatory - This method must be implemented.

    • getTotalTargetIndividualEffortMetadata

      Metadata getTotalTargetIndividualEffortMetadata()
      Gets the metadata for the total individual effort. The amount may be calculated from the other data.
      Returns:
      metadata for the total individual effort
      Compliance:
      mandatory - This method must be implemented.

    • setTotalTargetIndividualEffort

      void setTotalTargetIndividualEffort(Duration time)
      Sets the total individual effort.
      Parameters:
      time - the new total individual effort
      Throws:
      InvalidArgumentException - time is invalid
      NoAccessException - Metadata.isReadOnly() is true
      NullArgumentException - time is null
      Compliance:
      mandatory - This method must be implemented.

    • clearTotalTargetIndividualEffort

      void clearTotalTargetIndividualEffort()
      Removes the total individual effort.
      Throws:
      NoAccessException - Metadata.isRequired() is true or Metadata.isReadOnly() is true
      Compliance:
      mandatory - This method must be implemented.

    • getRecurringWeeklyMetadata

      Metadata getRecurringWeeklyMetadata()
      Gets the metadata for the recurring weekly flag.
      Returns:
      metadata for the contact
      Compliance:
      mandatory - This method must be implemented.

    • setRecurringWeekly

      void setRecurringWeekly(boolean recurring)
      Sets the recurring weekly flag.
      Parameters:
      recurring - the new recurring weekly flag
      Throws:
      InvalidArgumentException - recurring is invalid
      NoAccessException - Metadata.isReadOnly() is true
      Compliance:
      mandatory - This method must be implemented.

    • clearRecurringWeekly

      void clearRecurringWeekly()
      Removes the recurring weekly flag.
      Throws:
      NoAccessException - Metadata.isRequired() is true or Metadata.isReadOnly() is true
      Compliance:
      mandatory - This method must be implemented.

    • getWeeklyEffortMetadata

      Metadata getWeeklyEffortMetadata()
      Gets the metadata for the weekly effort. The amount may be calculated from the other data.
      Returns:
      metadata for the weekly effort
      Compliance:
      mandatory - This method must be implemented.

    • setWeeklyEffort

      void setWeeklyEffort(Duration time)
      Sets the weekly effort.
      Parameters:
      time - the new weekly effort
      Throws:
      InvalidArgumentException - time is invalid
      NoAccessException - Metadata.isReadOnly() is true
      NullArgumentException - time is null
      Compliance:
      mandatory - This method must be implemented.

    • clearWeeklyEffort

      void clearWeeklyEffort()
      Removes the weekly effort.
      Throws:
      NoAccessException - Metadata.isRequired() is true or Metadata.isReadOnly() is true
      Compliance:
      mandatory - This method must be implemented.

    • getWeeklyContactTimeMetadata

      Metadata getWeeklyContactTimeMetadata()
      Gets the metadata for the weekly contact time.
      Returns:
      metadata for the weekly contact time
      Compliance:
      mandatory - This method must be implemented.

    • setWeeklyContactTime

      void setWeeklyContactTime(Duration time)
      Sets the weekly contact time.
      Parameters:
      time - the new weekly contact time
      Throws:
      InvalidArgumentException - time is invalid
      NoAccessException - Metadata.isReadOnly() is true
      NullArgumentException - time is null
      Compliance:
      mandatory - This method must be implemented.

    • clearWeeklyContactTime

      void clearWeeklyContactTime()
      Removes the weekly contact time.
      Throws:
      NoAccessException - Metadata.isRequired() is true or Metadata.isReadOnly() is true
      Compliance:
      mandatory - This method must be implemented.

    • getWeeklyIndividualEffortMetadata

      Metadata getWeeklyIndividualEffortMetadata()
      Gets the metadata for the weekly individual effort. The amount may be calculated from the other data.
      Returns:
      metadata for the weekly individual effort
      Compliance:
      mandatory - This method must be implemented.

    • setWeeklyIndividualEffort

      void setWeeklyIndividualEffort(Duration time)
      Sets the weekly individual effort.
      Parameters:
      time - the new weekly individual effort
      Throws:
      InvalidArgumentException - time is invalid
      NoAccessException - Metadata.isReadOnly() is true
      NullArgumentException - time is null
      Compliance:
      mandatory - This method must be implemented.

    • clearWeeklyIndividualEffort

      void clearWeeklyIndividualEffort()
      Removes the weekly individual effort.
      Throws:
      NoAccessException - Metadata.isRequired() is true 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 - an 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.