OSID Logo
OSID Specifications
provisioning package
Version 3.1.0
Interfaceosid.provisioning.DistributorList
Implementsosid.OsidList
Used Byosid.provisioning.BrokerDistributorSession
osid.provisioning.DistributorHierarchySession
osid.provisioning.DistributorLookupSession
osid.provisioning.DistributorQuerySession
osid.provisioning.DistributorSearchResults
osid.provisioning.PoolDistributorSession
osid.provisioning.ProvisionDistributorSession
osid.provisioning.ProvisionableDistributorSession
osid.provisioning.QueueDistributorSession
osid.provisioning.RequestDistributorSession
show 17 more…
osid.provisioning.rules.BrokerConstrainerDistributorSession
osid.provisioning.rules.BrokerConstrainerEnablerDistributorSession
osid.provisioning.rules.BrokerEnablerDistributorSession
osid.provisioning.rules.BrokerProcessorDistributorSession
osid.provisioning.rules.BrokerProcessorEnablerDistributorSession
osid.provisioning.rules.PoolConstrainerDistributorSession
osid.provisioning.rules.PoolConstrainerEnablerDistributorSession
osid.provisioning.rules.PoolEnablerDistributorSession
osid.provisioning.rules.PoolProcessorDistributorSession
osid.provisioning.rules.PoolProcessorEnablerDistributorSession
osid.provisioning.rules.ProvisionEnablerDistributorSession
osid.provisioning.rules.ProvisionableEnablerDistributorSession
osid.provisioning.rules.QueueConstrainerDistributorSession
osid.provisioning.rules.QueueConstrainerEnablerDistributorSession
osid.provisioning.rules.QueueEnablerDistributorSession
osid.provisioning.rules.QueueProcessorDistributorSession
osid.provisioning.rules.QueueProcessorEnablerDistributorSession
Description

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

while (dl.hasNext()) {
     Distributor distributor = dl.getNextDistributor();
}
                
or
while (dl.hasNext()) {
     Distributor[] distributors = dl.getNextDistributors(dl.available());
}
                
MethodgetNextDistributor
Description

Gets the next Distributor in this list.

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

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

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