Interface TermForm

All Superinterfaces:
Extensible, Identifiable, OsidBrowsableForm, OsidExtensibleForm, OsidFederateableForm, OsidForm, OsidIdentifiableForm, OsidObjectForm, Suppliable
All Known Subinterfaces:
TermBatchForm
public interface TermForm extends OsidObjectForm, OsidFederateableForm

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

  • Method Details

    • getDisplayLabelMetadata

      Metadata getDisplayLabelMetadata()
      Gets the metadata for a display label title.
      Returns:
      metadata for the display label
      Compliance:
      mandatory - This method must be implemented.

    • setDisplayLabel

      void setDisplayLabel(String displayLabel)
      Sets the display label.
      Parameters:
      displayLabel - the new display label
      Throws:
      InvalidArgumentException - displayLabel is invalid
      NoAccessException - Metadata.isReadOnly() is true
      NullArgumentException - displayLabel is null
      Compliance:
      mandatory - This method must be implemented.

    • clearDisplayLabel

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

    • getOpenDateMetadata

      Metadata getOpenDateMetadata()
      Gets the metadata for an open date.
      Returns:
      metadata for the open date
      Compliance:
      mandatory - This method must be implemented.

    • setOpenDate

      void setOpenDate(DateTime date)
      Sets the open date.
      Parameters:
      date - the new open date
      Throws:
      InvalidArgumentException - date is invalid
      NoAccessException - date cannot be modified
      NullArgumentException - date is null
      Compliance:
      mandatory - This method must be implemented.

    • clearOpenDate

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

    • getRegistrationStartMetadata

      Metadata getRegistrationStartMetadata()
      Gets the metadata for the registration start date.
      Returns:
      metadata for the registration start date
      Compliance:
      mandatory - This method must be implemented.

    • setRegistrationStart

      void setRegistrationStart(DateTime date)
      Sets the registration start date.
      Parameters:
      date - the new registration start date
      Throws:
      InvalidArgumentException - date is invalid
      NoAccessException - date cannot be modified
      NullArgumentException - date is null
      Compliance:
      mandatory - This method must be implemented.

    • clearRegistrationStart

      void clearRegistrationStart()
      Clears the registration start date.
      Throws:
      NoAccessException - Metadata.isRequired() or Metadata.isReadOnly() is true
      Compliance:
      mandatory - This method must be implemented.

    • getRegistrationEndMetadata

      Metadata getRegistrationEndMetadata()
      Gets the metadata for the registration end date.
      Returns:
      metadata for the registration end date
      Compliance:
      mandatory - This method must be implemented.

    • setRegistrationEnd

      void setRegistrationEnd(DateTime date)
      Sets the registration end date.
      Parameters:
      date - the new registration end date
      Throws:
      InvalidArgumentException - date is invalid
      NoAccessException - date cannot be modified
      NullArgumentException - date is null
      Compliance:
      mandatory - This method must be implemented.

    • clearRegistrationEnd

      void clearRegistrationEnd()
      Clears the registration end date.
      Throws:
      NoAccessException - Metadata.isRequired() or Metadata.isReadOnly() is true
      Compliance:
      mandatory - This method must be implemented.

    • getClassesStartMetadata

      Metadata getClassesStartMetadata()
      Gets the metadata for the classes start date.
      Returns:
      metadata for the classes start date
      Compliance:
      mandatory - This method must be implemented.

    • setClassesStart

      void setClassesStart(DateTime date)
      Sets the classes start date.
      Parameters:
      date - the new classes start date
      Throws:
      InvalidArgumentException - date is invalid
      NoAccessException - date cannot be modified
      NullArgumentException - date is null
      Compliance:
      mandatory - This method must be implemented.

    • clearClassesStart

      void clearClassesStart()
      Clears the classes start date.
      Throws:
      NoAccessException - Metadata.isRequired() or Metadata.isReadOnly() is true
      Compliance:
      mandatory - This method must be implemented.

    • getClassesEndMetadata

      Metadata getClassesEndMetadata()
      Gets the metadata for the classes end date.
      Returns:
      metadata for the classes end date
      Compliance:
      mandatory - This method must be implemented.

    • setClassesEnd

      void setClassesEnd(DateTime date)
      Sets the classes end date.
      Parameters:
      date - the new classes end date
      Throws:
      InvalidArgumentException - date is invalid
      NoAccessException - date cannot be modified
      NullArgumentException - date is null
      Compliance:
      mandatory - This method must be implemented.

    • clearClassesEnd

      void clearClassesEnd()
      Clears the classes end date.
      Throws:
      NoAccessException - Metadata.isRequired() or Metadata.isReadOnly() is true
      Compliance:
      mandatory - This method must be implemented.

    • getAddDateMetadata

      Metadata getAddDateMetadata()
      Gets the metadata for the add date.
      Returns:
      metadata for the add date
      Compliance:
      mandatory - This method must be implemented.

    • setAddDate

      void setAddDate(DateTime date)
      Sets the add date.
      Parameters:
      date - the new add date
      Throws:
      InvalidArgumentException - date is invalid
      NoAccessException - date cannot be modified
      NullArgumentException - date is null
      Compliance:
      mandatory - This method must be implemented.

    • clearAddDate

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

    • getDropDateMetadata

      Metadata getDropDateMetadata()
      Gets the metadata for the drop date.
      Returns:
      metadata for the drop date
      Compliance:
      mandatory - This method must be implemented.

    • setDropDate

      void setDropDate(DateTime date)
      Sets the drop date.
      Parameters:
      date - the new drop date
      Throws:
      InvalidArgumentException - date is invalid
      NoAccessException - date cannot be modified
      NullArgumentException - date is null
      Compliance:
      mandatory - This method must be implemented.

    • clearDropDate

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

    • getFinalExamStartMetadata

      Metadata getFinalExamStartMetadata()
      Gets the metadata for the classes start date.
      Returns:
      metadata for the classes start date
      Compliance:
      mandatory - This method must be implemented.

    • setFinalExamStart

      void setFinalExamStart(DateTime date)
      Sets the final exam start date.
      Parameters:
      date - the new final exam start date
      Throws:
      InvalidArgumentException - date is invalid
      NoAccessException - date cannot be modified
      NullArgumentException - date is null
      Compliance:
      mandatory - This method must be implemented.

    • clearFinalExamStart

      void clearFinalExamStart()
      Clears the final exam start date.
      Throws:
      NoAccessException - Metadata.isRequired() or Metadata.isReadOnly() is true
      Compliance:
      mandatory - This method must be implemented.

    • getFinalExamEndMetadata

      Metadata getFinalExamEndMetadata()
      Gets the metadata for the final exam end date.
      Returns:
      metadata for the final exam end date
      Compliance:
      mandatory - This method must be implemented.

    • setFinalExamEnd

      void setFinalExamEnd(DateTime date)
      Sets the final exam end date.
      Parameters:
      date - the new final exam end date
      Throws:
      InvalidArgumentException - date is invalid
      NoAccessException - date cannot be modified
      NullArgumentException - date is null
      Compliance:
      mandatory - This method must be implemented.

    • clearFinalExamEnd

      void clearFinalExamEnd()
      Clears the final exam end date.
      Throws:
      NoAccessException - Metadata.isRequired() or Metadata.isReadOnly() is true
      Compliance:
      mandatory - This method must be implemented.

    • getCloseDateMetadata

      Metadata getCloseDateMetadata()
      Gets the metadata for the close date.
      Returns:
      metadata for the close date
      Compliance:
      mandatory - This method must be implemented.

    • setCloseDate

      void setCloseDate(DateTime date)
      Sets the close date.
      Parameters:
      date - the new close date
      Throws:
      InvalidArgumentException - date is invalid
      NoAccessException - date cannot be modified
      NullArgumentException - date is null
      Compliance:
      mandatory - This method must be implemented.

    • clearCloseDate

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

    • getTermFormRecord

      TermFormRecord getTermFormRecord(Type termRecordType) throws OperationFailedException
      Gets the TermFormRecord corresponding to the given term record Type.
      Parameters:
      termRecordType - a term record type
      Returns:
      the term form record
      Throws:
      NullArgumentException - termRecordType is null
      OperationFailedException - unable to complete request
      UnsupportedException - hasRecordType(termRecordType) is false
      Compliance:
      mandatory - This method must be implemented.