org.osid.id

Interface IdList

All Superinterfaces:

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

public interface IdList
extends OsidList

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

       
       
       while (il.hasNext()) {
            Id id = il.getNextId();
       }
       
                   
       
  

or

       
       
       while (il.hasNext()) {
            Id[] ids = il.getNextIds(il.available());
       }
       
                   
       
  

Method Summary

Methods

Modifier and Type	Method and Description
Id	getNextId() Gets the next Id in this list.
Id[]	getNextIds(long n) Gets the next set of Ids 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

getNextId

Id getNextId()
             throws OperationFailedException

Gets the next Id in this list.

Returns:

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

getNextIds

Id[] getNextIds(long n)
                throws OperationFailedException

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

Parameters:

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

Returns:

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