Interface QueueForm

All Superinterfaces:
Extensible, Identifiable, OsidBrowsableForm, OsidExtensibleForm, OsidForm, OsidGovernatorForm, OsidIdentifiableForm, OsidObjectForm, OsidOperableForm, OsidSourceableForm, OsidSubjugateableForm, Suppliable
All Known Subinterfaces:
QueueBatchForm
public interface QueueForm extends OsidGovernatorForm, OsidSubjugateableForm

This is the form for creating and updating Queues .Like all OsidForm objects, various data elements may be set here for use in the create and update methods in the QueueAdminSession . For each data element that may be set, metadata may be examined to provide display hints or data constraints. Some data may be automatically derived from the queue segments.

  • Method Details

    • getCanSpecifyProvisionableMetadata

      Metadata getCanSpecifyProvisionableMetadata()
      Gets the metadata for the can request provisionables flag.
      Returns:
      metadata for the can request provisionables flag
      Compliance:
      mandatory - This method must be implemented.

    • setCanSpecifyProvisionable

      void setCanSpecifyProvisionable(long canRequest)
      Sets the can request provisionables flag.
      Parameters:
      canRequest - the new can request provisionables flag
      Throws:
      InvalidArgumentException - canRequest is invalid
      NoAccessException - Metadata.isReadOnly() is true
      Compliance:
      mandatory - This method must be implemented.

    • clearCanSpecifyProvisionable

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

    • getManagersMetadata

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

    • setManagers

      void setManagers(IdList managerIds)
      Sets the managers.
      Parameters:
      managerIds - the manager Ids
      Throws:
      InvalidArgumentException - managerIds is invalid
      NoAccessException - Metadata.isReadOnly() is true
      NullArgumentException - managerIds is null
      Compliance:
      mandatory - This method must be implemented.

    • clearManagers

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

    • getQueueFormRecord

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