OSID Logo
OSID Specifications
provisioning rules package
Version 3.0.0
Interfaceosid.provisioning.rules.ProvisionableEnablerList
Implementsosid.OsidList
Used Byosid.provisioning.rules.ProvisionableEnablerDistributorSession
osid.provisioning.rules.ProvisionableEnablerLookupSession
osid.provisioning.rules.ProvisionableEnablerQuerySession
osid.provisioning.rules.ProvisionableEnablerRuleLookupSession
osid.provisioning.rules.ProvisionableEnablerSearchResults
Description

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

while (pel.hasNext()) {
     ProvisionableEnabler enabler = pel.getNextProvisionableEnabler();
}

or

while (pel.hasNext()) {
     ProvisionableEnabler[] enablers = pel.getNextProvisionableEnablers(pel.available());
}            
                
MethodgetNextProvisionableEnabler
Description

Gets the next ProvisionableEnabler in this list.

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

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

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