OSID Logo
OSID Specifications
mapping path package
Version 3.0.0
Release Candidate Preview
Interfaceosid.mapping.path.ResourceVelocityList
Implementsosid.OsidList
Description

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

                     
                     
                     while (rvl.hasNext()) {
                          ResourceVelocity velocity = rvl.getNextResourceVelocity();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (rvl.hasNext()) {
                          ResourceVelocity[] velocities = rvl.getNextResourceVelocities(rvl.available());
                     }
                     
                                 
                     
                
MethodgetNextResourceVelocity
Description

Gets the next ResourceVelocity in this list.

Returnosid.mapping.path.ResourceVelocitythe next ResourceVelocity in this list. The hasNext() method should be used to test that a next ResourceVelocity is available before calling this method.
ErrorsILLEGAL_STATEno more elements available in this list
OPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodgetNextResourceVelocities
Description

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

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