OSID Logo
OSID Specifications
configuration rules package
Version 3.1.0
Interfaceosid.configuration.rules.ValueEnablerList
Implementsosid.OsidList
Used Byosid.configuration.rules.ValueEnablerConfigurationSession
osid.configuration.rules.ValueEnablerLookupSession
osid.configuration.rules.ValueEnablerQuerySession
osid.configuration.rules.ValueEnablerRuleLookupSession
osid.configuration.rules.ValueEnablerSearchResults
Description

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

while (vel.hasNext()) {
     ValueEnabler enabler = vel.getNextValueEnabler();
}
                
or
while (vel.hasNext()) {
     ValueEnabler[] enablers = vel.getNextValueEnablers(vel.available());
}
                
MethodgetNextValueEnabler
Description

Gets the next ValueEnabler in this list.

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

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

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