OSID Logo
OSID Specifications
control package
Version 3.1.0
Interfaceosid.control.ActionGroupList
Implementsosid.OsidList
Used Byosid.control.ActionGroupLookupSession
osid.control.ActionGroupQuerySession
osid.control.ActionGroupSearchResults
osid.control.ActionGroupSystemSession
osid.control.Trigger
Description

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

while (agl.hasNext()) {
     ActionGroup group = agl.getNextActionGroup();
}
                
or
while (agl.hasNext()) {
     ActionGroup[] groups = agl.getNextActionGroups(agl.available());
}
                
MethodgetNextActionGroup
Description

Gets the next ActionGroup in this list.

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

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

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