OSID Logo
OSID Specifications
workflow package
Version 3.0.0
Release Candidate Preview
Interfaceosid.workflow.OfficeList
Implementsosid.OsidList
Description

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

                     
                     
                     while (ol.hasNext()) {
                          Office office = ol.getNextOffice();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (ol.hasNext()) {
                          Office[] offices = ol.getNextOffices(ol.available());
                     }
                     
                                 
                     
                
MethodgetNextOffice
Description

Gets the next Office in this list.

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

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

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