org.osid.dictionary

Interface DictionaryList

All Superinterfaces:

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

public interface DictionaryList
extends OsidList

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

       
       
       while (dl.hasNext()) {
            Dictionary dictionary = dl.getNextDictionary();
       }
       
                   
       
  

or

       
       
       while (dl.hasNext()) {
            Dictionary[] dictionaries = dl.getNextDictionaries(dl.available());
       }
       
                   
       
  

Method Summary

Methods

Modifier and Type	Method and Description
Dictionary[]	getNextDictionaries(long n) Gets the next set of Dictionary objects in this lis which must be less than or equal to whst is returned from available().
Dictionary	getNextDictionary() Gets the next Dictionary 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

getNextDictionary

Dictionary getNextDictionary()
                             throws OperationFailedException

Gets the next Dictionary in this list.

Returns:

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

getNextDictionaries

Dictionary[] getNextDictionaries(long n)
                                 throws OperationFailedException

Gets the next set of Dictionary objects in this lis which must be less than or equal to whst is returned from available().

Parameters:

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

Returns:

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