Interface QueueConstrainer

All Superinterfaces:
Browsable, Extensible, Identifiable, Operable, OsidConstrainer, OsidObject, OsidRule
public interface QueueConstrainer extends OsidConstrainer

A QueueConstrainer manages the constraints of a Queue .

  • Method Details

    • hasSizeLimit

      boolean hasSizeLimit()
      Tests if this queue limits the number of requests.
      Returns:
      true if a queue size limit is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • getSizeLimit

      long getSizeLimit()
      Gets the size limit of the queue.
      Returns:
      the size limit
      Throws:
      IllegalStateException - hasSizeLimit() is false
      Compliance:
      mandatory - This method must be implemented.

    • requiresProvisions

      boolean requiresProvisions()
      Tests if a provision must exist before entering this queue.
      Returns:
      true if a provision is required, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • getRequiredProvisionPoolIds

      IdList getRequiredProvisionPoolIds()
      Gets the pool Ids for the required provisions.
      Returns:
      the Ids of the pools
      Throws:
      IllegalStateException - requiresProvisions() is false
      Compliance:
      mandatory - This method must be implemented.

    • getRequiredProvisionPools

      PoolList getRequiredProvisionPools() throws OperationFailedException
      Gets the pools for the required provisions.
      Returns:
      the pools
      Throws:
      IllegalStateException - requiresProvisions() is false
      OperationFailedException - unable to complete request
      Compliance:
      mandatory - This method must be implemented.

    • getQueueConstrainerRecord

      QueueConstrainerRecord getQueueConstrainerRecord(Type queueConstrainerRecordType) throws OperationFailedException
      Gets the queue constrainer record corresponding to the given QueueConstrainer record Type . This method ie used to retrieve an object implementing the requested record. The queueConstrainerRecordType may be the Type returned in getRecordTypes() or any of its parents in a Type hierarchy where hasRecordType(queueConstrainerRecordType) is true.
      Parameters:
      queueConstrainerRecordType - the type of queue constrainer record to retrieve
      Returns:
      the queue constrainer record
      Throws:
      NullArgumentException - queueConstrainerRecordType is null
      OperationFailedException - unable to complete request
      UnsupportedException - hasRecordType(queueConstrainerRecordType) is false
      Compliance:
      mandatory - This method must be implemented.