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.
Modifier and Type | Method and Description |
---|---|
boolean |
canSpecifyProvisionable()
Tests if this queue allows a specific provisionable to be requested.
|
Broker |
getBroker()
Gets the broker.
|
Id |
getBrokerId()
Gets the broker
Id. |
Duration |
getEWA()
Gets the estimated waiting time for new requests in this queue.
|
QueueRecord |
getQueueRecord(Type queueRecordType)
Gets the queue record corresponding to the given
Queue
record Type. |
long |
getSize()
Gets the size of the queue.
|
boolean |
hasEWA()
Tests if an estimated waiting time is available for this queue.
|
boolean |
hasSize()
Tests if a queue size is available.
|
getDescription, getDisplayName, getGenusType, isOfGenusType
getId, isCurrent
getRecordTypes, hasRecordType
getProperties, getPropertiesByRecordType
isActive, isDisabled, isEnabled, isOperational
getBranding, getBrandingIds, getLicense, getProvider, getProviderId
Id getBrokerId()
Id.
Id
mandatory
- This method must be implemented. Broker getBroker() throws OperationFailedException
OperationFailedException
- unable to complete requestmandatory
- This method must be implemented. boolean hasSize()
true
if a queue size is available, false
otherwisemandatory
- This method must be implemented. long getSize()
IllegalStateException
- hasSize()
is
false
mandatory
- This method must be implemented. boolean hasEWA()
true
if an ewa is available, false
otherwisemandatory
- This method must be implemented. Duration getEWA()
IllegalStateException
- hasEWA()
is
false
mandatory
- This method must be implemented. boolean canSpecifyProvisionable()
true
if provisionables can be specified,
false
otherwisemandatory
- This method must be implemented. QueueRecord getQueueRecord(Type queueRecordType) throws OperationFailedException
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
.queueRecordType
- the type of queue record to retrieveNullArgumentException
- queueRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(queueRecordType)
is false
mandatory
- This method must be implemented.