Interface QueueProcessorForm

All Superinterfaces:
Extensible, Identifiable, OsidBrowsableForm, OsidExtensibleForm, OsidForm, OsidIdentifiableForm, OsidObjectForm, OsidOperableForm, OsidProcessorForm, OsidRuleForm, Suppliable
public interface QueueProcessorForm extends OsidProcessorForm

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

Like all OsidForms, QueueProcessorForm is stateful and must not be accessed by multiple processing threads.

  • Method Details

    • getQueueProcessorFormRecord

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