org.osid.subscription

Interface PublisherList

All Superinterfaces:

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

public interface PublisherList
extends OsidList

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

       
       
       while (pl.hasNext()) {
            Publisher publisher = pl.getNextPublisher();
       }
       
                   
       
  

or

       
       
       while (pl.hasNext()) {
            Publisher[] publishers = pl.getNextPublishers(pl.available());
       }
       
                   
       
  

Method Summary

Methods

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

getNextPublisher

Publisher getNextPublisher()
                           throws OperationFailedException

Gets the next Publisher in this list.

Returns:

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

getNextPublishers

Publisher[] getNextPublishers(long n)
                              throws OperationFailedException

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

Parameters:

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

Returns:

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