OSID Logo
OSID Specifications
hold rules package
Version 3.0.0
Release Candidate Preview
Interfaceosid.hold.rules.HoldEnablerList
Implementsosid.OsidList
Description

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

                     
                     
                     while (hel.hasNext()) {
                          HoldEnabler enabler = hel.getNextHoldEnabler();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (hel.hasNext()) {
                          HoldEnabler[] enablers = hel.getNextHoldEnablers hel.available());
                     }
                     
                                 
                     
                
MethodgetNextHoldEnabler
Description

Gets the next HoldEnabler in this list.

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

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

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