OSID Logo
OSID Specifications
repository rules package
Version 3.1.0
Interfaceosid.repository.rules.CompositionEnablerList
Implementsosid.OsidList
Used Byosid.repository.rules.CompositionEnablerLookupSession
osid.repository.rules.CompositionEnablerQuerySession
osid.repository.rules.CompositionEnablerRepositorySession
osid.repository.rules.CompositionEnablerRuleLookupSession
osid.repository.rules.CompositionEnablerSearchResults
Description

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

while (cel.hasNext()) {
     CompositionEnabler enabler = cel.getNextCompositionEnabler();
}
                
or
while (cel.hasNext()) {
     CompositionEnabler[] enablers = cel.getNextCompositionEnablers cel.available());
}
                
MethodgetNextCompositionEnabler
Description

Gets the next CompositionEnabler in this list.

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

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

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