Interface SubjectForm

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

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

  • Method Details

    • getCodeMetadata

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

    • setCode

      void setCode(String code)
      Sets the code.
      Parameters:
      code - the new 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.

    • getSubjectFormRecord

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