OSID Logo
OSID Specifications
transport package
Version 3.0.0
Release Candidate Preview
Interfaceosid.transport.EndpointList
Implementsosid.OsidList
Description

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

                     
                     
                     while (el.hasNext()) {
                          Endpoint endpoint = el.getNextEndpoint();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (el.hasNext()) {
                          Endpoint[] endpoints = el.getNextEndpoints(el.available());
                     }
                     
                                 
                     
                
MethodgetNextEndpoint
Description

Gets the next Endpoint in this list.

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

Gets the next set of Endpoint objects in this lis which must be less than or equal to whst is returned from available().

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