OSID Logo
OSID Specifications
inquiry rules package
Version 3.0.0
Release Candidate Preview
Interfaceosid.inquiry.rules.AuditEnablerList
Implementsosid.OsidList
Description

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

                     
                     
                     while (ael.hasNext()) {
                          AuditEnabler enabler = ael.getNextAuditEnabler();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (ael.hasNext()) {
                          AuditEnabler[] enablers = ael.getNextAuditEnablers(ael.available());
                     }
                     
                                 
                     
                
MethodgetNextAuditEnabler
Description

Gets the next AuditEnabler in this list.

Returnosid.inquiry.rules.AuditEnablerthe next AuditEnabler in this list. The hasNext() method should be used to test that a next AuditEnabler is available before calling this method.
ErrorsILLEGAL_STATEno more elements available in this list
OPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodgetNextAuditEnablers
Description

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

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