OSID Logo
OSID Specifications
provisioning rules package
Version 3.1.0
Interfaceosid.provisioning.rules.QueueConstrainerList
Implementsosid.OsidList
Used Byosid.provisioning.rules.QueueConstrainerDistributorSession
osid.provisioning.rules.QueueConstrainerEnablerRuleLookupSession
osid.provisioning.rules.QueueConstrainerLookupSession
osid.provisioning.rules.QueueConstrainerQuerySession
osid.provisioning.rules.QueueConstrainerRuleLookupSession
osid.provisioning.rules.QueueConstrainerSearchResults
Description

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

while (qcl.hasNext()) {
     QueueConstrainer constrainer = qcl.getNextQueueConstrainer();
}

or

while (qcl.hasNext()) {
     QueueConstrainer[] constrainers = qcl.getNextQueueConstrainers(qcl.available());
}
                
MethodgetNextQueueConstrainer
Description

Gets the next QueueConstrainer in this list.

Returnosid.provisioning.rules.QueueConstrainer the next QueueConstrainer in this list. The hasNext() method should be used to test that a next QueueConstrainer 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.
MethodgetNextQueueConstrainers
Description

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

Parameterscardinaln the number of QueueConstrainer elements requested which must be less than or equal to available()
Returnosid.provisioning.rules.QueueConstrainer[] an array of QueueConstrainer 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.