Interface CanonicalUnitForm

All Superinterfaces:
Extensible, Identifiable, OsidBrowsableForm, OsidExtensibleForm, OsidForm, OsidIdentifiableForm, OsidObjectForm, OsidOperableForm, Suppliable
All Known Subinterfaces:
CanonicalUnitBatchForm
public interface CanonicalUnitForm extends OsidObjectForm, OsidOperableForm

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

  • Method Details

    • getTitleMetadata

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

    • setTitle

      void setTitle(String title)
      Sets the title.
      Parameters:
      title - the title
      Throws:
      InvalidArgumentException - title is invalid
      NoAccessException - Metadata.isReadOnly() is true
      NullArgumentException - title is null
      Compliance:
      mandatory - This method must be implemented.

    • clearTitle

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

    • getCodeMetadata

      Metadata getCodeMetadata()
      Gets the metadata for a given name.
      Returns:
      metadata for the given name
      Compliance:
      mandatory - This method must be implemented.

    • setCode

      void setCode(String code)
      Sets the code.
      Parameters:
      code - the code
      Throws:
      InvalidArgumentException - code is invalid
      NoAccessException - Metadata.isReadOnly() is true
      NullArgumentException - code is null
      Compliance:
      mandatory - This method must be implemented.

    • clearCode

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

    • getOfferedCyclicTimePeriodsMetadata

      Metadata getOfferedCyclicTimePeriodsMetadata()
      Gets the metadata for a the cyclic time periods.
      Returns:
      metadata for the cyclic time periods
      Compliance:
      mandatory - This method must be implemented.

    • setOfferedCyclicTimePeriods

      void setOfferedCyclicTimePeriods(Id[] cyclicTimePeriodIds)
      Sets the cyclic time periods.
      Parameters:
      cyclicTimePeriodIds - the cyclic time periods
      Throws:
      InvalidArgumentException - cylciPeriodIds is invalid
      NoAccessException - Metadata.isReadOnly() is true
      NullArgumentException - cyclicPeriodIds is null
      Compliance:
      mandatory - This method must be implemented.

    • clearOfferedCyclicTimePeriods

      void clearOfferedCyclicTimePeriods()
      Clears the cyclic time periods.
      Throws:
      NoAccessException - Metadata.isRequired() or Metadata.isReadOnly() is true
      Compliance:
      mandatory - This method must be implemented.

    • getResultOptionsMetadata

      Metadata getResultOptionsMetadata()
      Gets the metadata for the grading options.
      Returns:
      metadata for the prerequisite information
      Compliance:
      mandatory - This method must be implemented.

    • setResultOptions

      void setResultOptions(Id[] gradeSystemIds)
      Sets the grading options.
      Parameters:
      gradeSystemIds - the new grading options
      Throws:
      InvalidArgumentException - gradeSystemIds is invalid
      NoAccessException - Metadata.isReadOnly() is true
      NullArgumentException - gradeSystemIds is null
      Compliance:
      mandatory - This method must be implemented.

    • clearResultOptions

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

    • getSponsorsMetadata

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

    • setSponsors

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

    • clearSponsors

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

    • getCanonicalUnitFormRecord

      CanonicalUnitFormRecord getCanonicalUnitFormRecord(Type canonicalUnitRecordType) throws OperationFailedException
      Gets the CanonicalUnitFormRecord interface corresponding to the given canonical unit record Type.
      Parameters:
      canonicalUnitRecordType - the canonical unit record type
      Returns:
      the record
      Throws:
      NullArgumentException - canonicalUnitRecordType is null
      OperationFailedException - unable to complete request
      UnsupportedException - hasRecordType(canonicalUnitRecordType) is false
      Compliance:
      mandatory - This method must be implemented.