Interface QueueConstrainerForm

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

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

  • Method Details

    • getSizeLimitMetadata

      Metadata getSizeLimitMetadata()
      Gets the metadata for the size limit.
      Returns:
      metadata for the size limit
      Compliance:
      mandatory - This method must be implemented.

    • setSizeLimit

      void setSizeLimit(long limit)
      Sets the size limit.
      Parameters:
      limit - the new limit
      Throws:
      InvalidArgumentException - limit is invalid
      NoAccessException - Metadata.isReadOnly() is true
      Compliance:
      mandatory - This method must be implemented.

    • clearSizeLimit

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

    • getRequiresProvisionsMetadata

      Metadata getRequiresProvisionsMetadata()
      Gets the metadata for the requires provisions flag.
      Returns:
      metadata for the requires provisions flag
      Compliance:
      mandatory - This method must be implemented.

    • setRequiresProvisions

      void setRequiresProvisions(long requiresProvisions)
      Sets the requires provisions flag.
      Parameters:
      requiresProvisions - the new requires provisions
      Throws:
      InvalidArgumentException - requiresProvisions is invalid
      NoAccessException - Metadata.isReadOnly() is true
      Compliance:
      mandatory - This method must be implemented.

    • clearRequiresProvisions

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

    • getRequiredProvisionPoolsMetadata

      Metadata getRequiredProvisionPoolsMetadata()
      Gets the metadata for the required pools.
      Returns:
      metadata for the required pools
      Compliance:
      mandatory - This method must be implemented.

    • setRequiredProvisionPools

      void setRequiredProvisionPools(Id[] poolIds)
      Sets the required provision pools.
      Parameters:
      poolIds - the new pools
      Throws:
      InvalidArgumentException - poolIds is invalid
      NoAccessException - Metadata.isReadOnly() is true
      NullArgumentException - poolIds is null
      Compliance:
      mandatory - This method must be implemented.

    • clearRequiredProvisionPools

      void clearRequiredProvisionPools()
      Clears the required provision pools.
      Throws:
      NoAccessException - Metadata.isRequired() is true or Metadata.isReadOnly() is true
      Compliance:
      mandatory - This method must be implemented.

    • getQueueConstrainerFormRecord

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