OSID Logo
OSID Specifications
provisioning package
Version 3.0.0
Release Candidate Preview
Interfaceosid.provisioning.Queue
Implementsosid.OsidGovernator
osid.Subjugateable
Description

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

MethodgetBrokerId
Description

Gets the broker Id.

Returnosid.id.Idthe broker Id
CompliancemandatoryThis method must be implemented.
MethodgetBroker
Description

Gets the broker.

Returnosid.provisioning.Brokerthe broker
ErrorsOPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodhasSize
Description

Tests if a queue size is available.

Returnboolean true if a queue size is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetSize
Description

Gets the size of the queue.

Returncardinalthe size
ErrorsILLEGAL_STATE hasSize() is false
CompliancemandatoryThis method must be implemented.
MethodhasEWA
Description

Tests if an estimated waiting time is available for this queue.

Returnboolean true if an ewa is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetEWA
Description

Gets the estimated waiting time for new requests in this queue.

Returnosid.calendaring.Durationthe ewa
ErrorsILLEGAL_STATE hasEWA() is false
CompliancemandatoryThis method must be implemented.
MethodcanSpecifyProvisionable
Description

Tests if this queue allows a specific provisionable to be requested.

Returnboolean true if provisionables can be specified, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetQueueRecord
Description

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 .

Parametersosid.type.TypequeueRecordTypethe type of queue record to retrieve
Returnosid.provisioning.records.QueueRecordthe queue record
ErrorsNULL_ARGUMENT queueRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(queueRecordType) is false
CompliancemandatoryThis method must be implemented.