OSID Logo
OSID Specifications
provisioning rules package
Version 3.0.0
Interfaceosid.provisioning.rules.QueueEnablerList
Implementsosid.OsidList
Used Byosid.provisioning.rules.QueueEnablerDistributorSession
osid.provisioning.rules.QueueEnablerLookupSession
osid.provisioning.rules.QueueEnablerQuerySession
osid.provisioning.rules.QueueEnablerRuleLookupSession
osid.provisioning.rules.QueueEnablerSearchResults
Description

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

while (qel.hasNext()) {
     QueueEnabler enabler = qel.getNextQueueEnabler();
}

or

while (qel.hasNext()) {
     QueueEnabler[] enablers = qel.getNextQueueEnablers(qel.available());
}            
                
MethodgetNextQueueEnabler
Description

Gets the next QueueEnabler in this list.

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

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

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