org.osid.mapping

Interface ResourceLocationList

All Superinterfaces:

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

public interface ResourceLocationList
extends OsidList

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

       
       
       while (rll.hasNext()) {
            ResourceLocation location = rll.getNextRouteResourceLocation();
       }
       
                   
       
  

or

       
       
       while (rll.hasNext()) {
            ResourceLocation[] locations = rll.getNextResourceLocations(rll.available());
       }
       
                   
       
  

Method Summary

Methods

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

getNextResourceLocation

ResourceLocation getNextResourceLocation()
                                         throws OperationFailedException

Gets the next ResourceLocation in this list.

Returns:

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

getNextResourceLocations

ResourceLocation[] getNextResourceLocations(long n)
                                            throws OperationFailedException

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

Parameters:

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

Returns:

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