OSID Logo
OSID Specifications
control rules package
Version 3.1.0
Interfaceosid.control.rules.TriggerEnablerList
Implementsosid.OsidList
Used Byosid.control.rules.TriggerEnablerLookupSession
osid.control.rules.TriggerEnablerQuerySession
osid.control.rules.TriggerEnablerRuleLookupSession
osid.control.rules.TriggerEnablerSearchResults
osid.control.rules.TriggerEnablerSystemSession
Description

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

while (tel.hasNext()) {
     TriggerEnabler enabler = tel.getNextTriggerEnabler();
}
                
or
while (tel.hasNext()) {
     TriggerEnabler[] enablers = tel.getNextTriggerEnablers(tel.available());
}
                
MethodgetNextTriggerEnabler
Description

Gets the next TriggerEnabler in this list.

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

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

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