org.osid.tracking

Interface FrontOfficeNodeList

All Superinterfaces:

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

public interface FrontOfficeNodeList
extends OsidList

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

       
       
       while (fonl.hasNext()) {
            FrontOfficeNode node = fonl.getNextFrontOfficeNode();
       }
       
                   
       
  

or

       
       
       while (fonl.hasNext()) {
            FrontOfficeNode[] nodes = fonl.getNextFrontOfficeNodes(fonl.available());
       }
       
                   
       
  

Method Summary

Methods

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

getNextFrontOfficeNode

FrontOfficeNode getNextFrontOfficeNode()
                                       throws OperationFailedException

Gets the next FrontOfficeNode in this list.

Returns:

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

getNextFrontOfficeNodes

FrontOfficeNode[] getNextFrontOfficeNodes(long n)
                                          throws OperationFailedException

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

Parameters:

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

Returns:

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