OSID Logo
OSID Specifications
provisioning rules package
Version 3.1.0
Interfaceosid.provisioning.rules.PoolConstrainerList
Implementsosid.OsidList
Used Byosid.provisioning.rules.PoolConstrainerDistributorSession
osid.provisioning.rules.PoolConstrainerEnablerRuleLookupSession
osid.provisioning.rules.PoolConstrainerLookupSession
osid.provisioning.rules.PoolConstrainerQuerySession
osid.provisioning.rules.PoolConstrainerRuleLookupSession
osid.provisioning.rules.PoolConstrainerSearchResults
Description

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

while (pcl.hasNext()) {
     PoolConstrainer constrainer = pcl.getNextPoolConstrainer();
}

or

while (pcl.hasNext()) {
     PoolConstrainer[] constrainers = pcl.getNextPoolConstrainers(pcl.available());
}
                
MethodgetNextPoolConstrainer
Description

Gets the next PoolConstrainer in this list.

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

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

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