org.osid.subscription.batch

Interface SubscriptionPeerList

All Superinterfaces:

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

public interface SubscriptionPeerList
extends OsidList

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

       
       
       while (spl.hasNext()) {
            SubscriptionPeer peer = spl.getNextSubscriptionPeer();
       }
       
                   
       
  

or

       
       
       while (spl.hasNext()) {
            SubscriptionPeer[] peers = spl.getNextSubscriptionPeers(spl.available());
       }
       
                   
       
  

Method Summary

Methods

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

getNextSubscriptionPeer

SubscriptionPeer getNextSubscriptionPeer()
                                         throws OperationFailedException

Gets the next SubscriptionPeer in this list.

Returns:

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

getNextSubscriptionPeers

SubscriptionPeer[] getNextSubscriptionPeers(long n)
                                            throws OperationFailedException

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

Parameters:

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

Returns:

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