OSID Logo
OSID Specifications
tracking package
Version 3.0.0
Release Candidate Preview
Interfaceosid.tracking.FrontOfficeNodeList
Implementsosid.OsidList
Description

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

                     
                     
                     while (fonl.hasNext()) {
                          FrontOfficeNode node = fonl.getNextFrontOfficeNode();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (fonl.hasNext()) {
                          FrontOfficeNode[] nodes = fonl.getNextFrontOfficeNodes(fonl.available());
                     }
                     
                                 
                     
                
MethodgetNextFrontOfficeNode
Description

Gets the next FrontOfficeNode in this list.

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

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

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