org.osid.hold

Interface HoldList

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, OsidList

public interface HoldList
extends OsidList

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

       
       
       while (hl.hasNext()) {
            Hold hold = hl.getNextHold();
       }
       
                   
       
  

or

       
       
       while (hl.hasNext()) {
            Hold[] holds = hl.getNextHolds(hl.available());
       }
       
                   
       
  

Method Summary

Methods

Modifier and Type	Method and Description
Hold	getNextHold() Gets the next Hold in this list.
Hold[]	getNextHolds(long n) Gets the next set of Hold elements in this list.

Methods inherited from interface org.osid.OsidList

available, hasNext, skip

Methods inherited from interface org.osid.binding.java.OsidList

close

Methods inherited from interface java.io.Closeable

close

Method Detail

getNextHold

Hold getNextHold()
                 throws OperationFailedException

Gets the next Hold in this list.

Returns:

the next Hold in this list. The hasNext() method should be used to test that a next Hold 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.

getNextHolds

Hold[] getNextHolds(long n)
                    throws OperationFailedException

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

Parameters:

n - the number of Hold elements requested which must be less than or equal to available()

Returns:

an array of Hold 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.