OSID Logo
OSID Specifications
control rules package
Version 3.1.0
Interfaceosid.control.rules.InputEnablerList
Implementsosid.OsidList
Used Byosid.control.rules.InputEnablerLookupSession
osid.control.rules.InputEnablerQuerySession
osid.control.rules.InputEnablerRuleLookupSession
osid.control.rules.InputEnablerSearchResults
osid.control.rules.InputEnablerSystemSession
Description

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

while (iel.hasNext()) {
     InputEnabler enabler =ipel.getNextInputEnabler();
}
                
or
while (iel.hasNext()) {
     InputEnabler[] enablers = iel.getNextInputEnablers(iel.available());
}
                
MethodgetNextInputEnabler
Description

Gets the next InputEnabler in this list.

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

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

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