OSID Logo
OSID Specifications
control package
Version 3.1.0
Interfaceosid.control.TriggerList
Implementsosid.OsidList
Used Byosid.control.TriggerLookupSession
osid.control.TriggerQuerySession
osid.control.TriggerSearchResults
osid.control.TriggerSystemSession
osid.control.rules.TriggerEnablerRuleLookupSession
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.Trigger the next Trigger in this list. The hasNext() method should be used to test that a next Trigger 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.
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().

Parameterscardinaln the 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_STATE no more elements available in this list
OPERATION_FAILED unable to complete request
Compliancemandatory This method must be implemented.