OSID Logo
OSID Specifications
provisioning package
Version 3.1.0
Interfaceosid.provisioning.QueueList
Implementsosid.OsidList
Used Byosid.provisioning.MyProvisionSession
osid.provisioning.QueueDistributorSession
osid.provisioning.QueueLookupSession
osid.provisioning.QueueQuerySession
osid.provisioning.QueueSearchResults
osid.provisioning.rules.QueueConstrainerRuleLookupSession
osid.provisioning.rules.QueueEnablerRuleLookupSession
osid.provisioning.rules.QueueProcessorRuleLookupSession
Description

Like all OsidLists, QueueList provides a means for accessing Queue elements sequentially either one at a time or many at a time. Examples:

while (ql.hasNext()) {
     Queue queue = ql.getNextQueue();
}
                
or
while (ql.hasNext()) {
     Queue[] queues = ql.getNextQueues(ql.available());
}
                
MethodgetNextQueue
Description

Gets the next Queue in this list.

Returnosid.provisioning.Queue the next Queue in this list. The hasNext() method should be used to test that a next Queue is available before calling this method.
ErrorsILLEGAL_STATE no more elements available in this list
OPERATION_FAILED unable to complete request
Compliancemandatory This method must be implemented.
MethodgetNextQueues
Description

Gets the next set of Queue elements in this list. The specified amount must be less than or equal to the return from available().

Parameterscardinaln the number of Queue elements requested which must be less than or equal to available()
Returnosid.provisioning.Queue[] an array of Queue elements. The length of the array is less than or equal to the number specified.
ErrorsILLEGAL_STATE no more elements available in this list
OPERATION_FAILED unable to complete request
Compliancemandatory This method must be implemented.