Interface ResourceVelocityList

All Superinterfaces:
AutoCloseable, Closeable, OsidList, OsidList
public interface ResourceVelocityList extends OsidList

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());
}

  • Method Details

    • getNextResourceVelocity

      ResourceVelocity getNextResourceVelocity() throws OperationFailedException
      Gets the next ResourceVelocity in this list.
      Returns:
      the next ResourceVelocity in this list. The hasNext() method should be used to test that a next ResourceVelocity is available before calling this method.
      Throws:
      IllegalStateException - no more elements available in this list
      OperationFailedException - unable to complete request
      Compliance:
      mandatory - This method must be implemented.

    • getNextResourceVelocities

      ResourceVelocity[] getNextResourceVelocities(long n) throws OperationFailedException
      Gets the next set of ResourceVelocity elements in this list. The specified amount must be less than or equal to the return from available() .
      Parameters:
      n - the number of ResourceVelocity elements requested which must be less than or equal to available()
      Returns:
      an array of ResourceVelocity elements. The length of the array is less than or equal to the number specified.
      Throws:
      IllegalStateException - no more elements available in this list
      OperationFailedException - unable to complete request
      Compliance:
      mandatory - This method must be implemented.