Interface Queue

All Superinterfaces:
Browsable, Extensible, Identifiable, Operable, OsidGovernator, OsidObject, Subjugateable
public interface Queue extends OsidGovernator, Subjugateable

A Queue is a list of resources in line for a provision. The rule indicates how requests are processed in this queue.

  • Method Details

    • getBrokerId

      Id getBrokerId()
      Gets the broker Id .
      Returns:
      the broker Id
      Compliance:
      mandatory - This method must be implemented.

    • getBroker

      Broker getBroker() throws OperationFailedException
      Gets the broker.
      Returns:
      the broker
      Throws:
      OperationFailedException - unable to complete request
      Compliance:
      mandatory - This method must be implemented.

    • getManagerIds

      IdList getManagerIds()
      Gets the Ids of the managers.
      Returns:
      the manager Ids
      Compliance:
      mandatory - This method must be implemented.

    • getManagers

      ResourceList getManagers() throws OperationFailedException
      Gets the managers.
      Returns:
      the managers
      Throws:
      OperationFailedException - unable to complete request
      Compliance:
      mandatory - This method must be implemented.

    • hasSize

      boolean hasSize()
      Tests if a queue size is available.
      Returns:
      true if a queue size is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • getSize

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

    • hasEWA

      boolean hasEWA()
      Tests if an estimated waiting time is available for this queue.
      Returns:
      true if an ewa is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • getEWA

      Duration getEWA()
      Gets the estimated waiting time for new requests in this queue.
      Returns:
      the ewa
      Throws:
      IllegalStateException - hasEWA() is false
      Compliance:
      mandatory - This method must be implemented.

    • canSpecifyProvisionable

      boolean canSpecifyProvisionable()
      Tests if this queue allows a specific provisionable to be requested.
      Returns:
      true if provisionables can be specified, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • getQueueRecord

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