OSID Logo
OSID Specifications
resourcing rules package
Version 3.1.0
Interfaceosid.resourcing.rules.CommissionEnablerList
Implementsosid.OsidList
Used Byosid.resourcing.rules.CommissionEnablerFoundrySession
osid.resourcing.rules.CommissionEnablerLookupSession
osid.resourcing.rules.CommissionEnablerQuerySession
osid.resourcing.rules.CommissionEnablerRuleLookupSession
osid.resourcing.rules.CommissionEnablerSearchResults
Description

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

while (cel.hasNext()) {
     CommissionEnabler enabler = cel.getNextCommissionEnabler();
}
                
or
while (cel.hasNext()) {
     CommissionEnabler[] enablers = cel.getNextCommissionEnablers(cel.available());
}
                
MethodgetNextCommissionEnabler
Description

Gets the next CommissionEnabler in this list.

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

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

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