Interface ChainForm

All Superinterfaces:
Extensible, Identifiable, OsidBrowsableForm, OsidExtensibleForm, OsidForm, OsidIdentifiableForm, OsidObjectForm, Suppliable
public interface ChainForm extends OsidObjectForm

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

  • Method Details

    • getFifoMetadata

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

    • setFifo

      void setFifo(boolean fifo)
      Sets the fifo flag.
      Parameters:
      fifo - true to append elements to the end of the chain,, false to place new elements at the top of the chain
      Throws:
      InvalidArgumentException - affirmative is invalid
      NoAccessException - Metadata.isReadOnly() is true
      Compliance:
      mandatory - This method must be implemented.

    • clearFifo

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

    • getChainFormRecord

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