org.osid.subscription

Interface PublisherNodeList

All Superinterfaces:

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

public interface PublisherNodeList
extends OsidList

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

       
       
       while (pnl.hasNext()) {
            PublisherNode node = pnl.getNextPublisherNode();
       }
       
                   
       
  

or

       
       
       while (pnl.hasNext()) {
            PublisherNode[] nodes = pnl.getNextPublisherNodes(pnl.available());
       }
       
                   
       
  

Method Summary

Methods

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

getNextPublisherNode

PublisherNode getNextPublisherNode()
                                   throws OperationFailedException

Gets the next PublisherNode in this list.

Returns:

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

getNextPublisherNodes

PublisherNode[] getNextPublisherNodes(long n)
                                      throws OperationFailedException

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

Parameters:

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

Returns:

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