OSID Logo
OSID Specifications
control package
Version 3.0.0
Release Candidate Preview
Interfaceosid.control.TriggerList
Implementsosid.OsidList
Description

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

                     
                     
                     while (tl.hasNext()) {
                          Trigger trigger = tl.getNextTrigger();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (tl.hasNext()) {
                          Trigger[] triggers = tl.getNextTriggers(tl.available());
                     }
                     
                                 
                     
                
MethodgetNextTrigger
Description

Gets the next Trigger in this list.

Returnosid.control.Triggerthe next Trigger in this list. The hasNext() method should be used to test that a next Trigger is available before calling this method.
ErrorsILLEGAL_STATEno more elements available in this list
OPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodgetNextTriggers
Description

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

Parameterscardinalnthe number of Trigger elements requested which must be less than or equal to available()
Returnosid.control.Trigger[]an array of Trigger elements. The length of the array is less than or equal to the number specified.
ErrorsILLEGAL_STATEno more elements available in this list
OPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.