org.osid.tracking

Interface FrontOfficeList

All Superinterfaces:

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

public interface FrontOfficeList
extends OsidList

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

       
       
       while (fol.hasNext()) {
            FrontOffice office = fol.getNextFrontOffice();
       }
       
                   
       
  

or

       
       
       while (fol.hasNext()) {
            FrontOffice[] offices = fol.getNextFrontOffices(fol.available());
       }
       
                   
       
  

Method Summary

Methods

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

getNextFrontOffice

FrontOffice getNextFrontOffice()
                               throws OperationFailedException

Gets the next FrontOffice in this list.

Returns:

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

getNextFrontOffices

FrontOffice[] getNextFrontOffices(long n)
                                  throws OperationFailedException

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

Parameters:

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

Returns:

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