OSID Logo
OSID Specifications
mapping path package
Version 3.1.0
Interfaceosid.mapping.path.ResourceVelocityList
Implementsosid.OsidList
Used Byosid.mapping.path.ResourceVelocitySession
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.ResourceVelocity the next ResourceVelocity in this list. The hasNext() method should be used to test that a next ResourceVelocity is available before calling this method.
ErrorsILLEGAL_STATE no more elements available in this list
OPERATION_FAILED unable to complete request
Compliancemandatory This 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().

Parameterscardinaln the 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_STATE no more elements available in this list
OPERATION_FAILED unable to complete request
Compliancemandatory This method must be implemented.