Interface EntryForm

All Superinterfaces:
Extensible, Identifiable, OsidBrowsableForm, OsidExtensibleForm, OsidForm, OsidIdentifiableForm, OsidObjectForm, Suppliable
All Known Subinterfaces:
EntryBatchForm
public interface EntryForm extends OsidObjectForm

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

  • Method Details

    • getValueMetadata

      Metadata getValueMetadata()
      Gets the metadata for the vakue.
      Returns:
      metadata for the value
      Compliance:
      mandatory - This method must be implemented.

    • setValue

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

    • clearValue

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

    • getEntryFormRecord

      EntryFormRecord getEntryFormRecord(Type entryRecordType) throws OperationFailedException
      Gets the EntryFormRecord corresponding to the given entry record Type .
      Parameters:
      entryRecordType - an entry record type
      Returns:
      the entry form record
      Throws:
      NullArgumentException - entryRecordType is null
      OperationFailedException - unable to complete request
      UnsupportedException - hasRecordType(entryRecordType) is false
      Compliance:
      mandatory - This method must be implemented.