OSID Logo
OSID Specifications
provisioning rules package
Version 3.0.0
Release Candidate Preview
Interfaceosid.provisioning.rules.QueueConstrainerEnablerList
Implementsosid.OsidList
Description

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

                     
                     
                     while (qcel.hasNext()) {
                          QueueConstrainerEnabler enabler = qcel.getNextQueueConstrainerEnabler();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (qcel.hasNext()) {
                          QueueConstrainerEnabler[] enablers = qcel.getNextQueueConstrainerEnablers(qcel.available());
                     }
                     
                                 
                     
                
MethodgetNextQueueConstrainerEnabler
Description

Gets the next QueueConstrainerEnabler in this list.

Returnosid.provisioning.rules.QueueConstrainerEnablerthe next QueueConstrainerEnabler in this list. The hasNext() method should be used to test that a next QueueConstrainerEnabler is available before calling this method.
ErrorsILLEGAL_STATEno more elements available in this list
OPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodgetNextQueueConstrainerEnablers
Description

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

Parameterscardinalnthe number of QueueConstrainerEnabler elements requested which must be less than or equal to available()
Returnosid.provisioning.rules.QueueConstrainerEnabler[]an array of QueueConstrainerEnabler elements. The length of the array is less than or equal to the number specified.
ErrorsILLEGAL_STATEno more elements available in this list
OPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.