OSID Logo
OSID Specifications
provisioning rules package
Version 3.0.0
Interfaceosid.provisioning.rules.ProvisionEnablerList
Implementsosid.OsidList
Used Byosid.provisioning.rules.ProvisionEnablerDistributorSession
osid.provisioning.rules.ProvisionEnablerLookupSession
osid.provisioning.rules.ProvisionEnablerQuerySession
osid.provisioning.rules.ProvisionEnablerRuleLookupSession
osid.provisioning.rules.ProvisionEnablerSearchResults
Description

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

while (pel.hasNext()) {
     ProvisionEnabler enabler = pel.getNextProvisionEnabler();
}

or

while (pel.hasNext()) {
     ProvisionEnabler[] enablers = pel.getNextProvisionEnablers(pel.available());
}            
                
MethodgetNextProvisionEnabler
Description

Gets the next ProvisionEnabler in this list.

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

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

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