Interface | osid.provisioning.Queue | ||
---|---|---|---|
Implements | osid.OsidGovernator | ||
osid.Subjugateable | |||
Description |
A | ||
Method | getBrokerId | ||
Description |
Gets the broker | ||
Return | osid.id.Id | the broker Id | |
Compliance | mandatory | This method must be implemented. | |
Method | getBroker | ||
Description |
Gets the broker. | ||
Return | osid.provisioning.Broker | the broker | |
Errors | OPERATION_FAILED | unable to complete request | |
Compliance | mandatory | This method must be implemented. | |
Method | hasSize | ||
Description |
Tests if a queue size is available. | ||
Return | boolean | true if a queue size is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getSize | ||
Description |
Gets the size of the queue. | ||
Return | cardinal | the size | |
Errors | ILLEGAL_STATE | hasSize() is false | |
Compliance | mandatory | This method must be implemented. | |
Method | hasEWA | ||
Description |
Tests if an estimated waiting time is available for this queue. | ||
Return | boolean | true if an ewa is available, false otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getEWA | ||
Description |
Gets the estimated waiting time for new requests in this queue. | ||
Return | osid.calendaring.Duration | the ewa | |
Errors | ILLEGAL_STATE | hasEWA() is false | |
Compliance | mandatory | This method must be implemented. | |
Method | canSpecifyProvisionable | ||
Description |
Tests if this queue allows a specific provisionable to be requested. | ||
Return | boolean | true if provisionables can be specified, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getQueueRecord | ||
Description |
Gets the queue record corresponding to the given | ||
Parameters | osid.type.Type | queueRecordType | the type of queue record to retrieve |
Return | osid.provisioning.records.QueueRecord | the queue record | |
Errors | NULL_ARGUMENT | queueRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
UNSUPPORTED | hasRecordType(queueRecordType) is false | ||
Compliance | mandatory | This method must be implemented. |