Interface RelevancyEnablerList

All Superinterfaces:

AutoCloseable, Closeable, OsidList, OsidList

public interface RelevancyEnablerList
extends OsidList

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

while (rel.hasNext()) {
     RelevancyEnabler enabler = rel.getNextRelevancyEnabler();
}            
  

or

while (rel.hasNext()) {
     RelevancyEnabler[] enablers = rel.getNextRelevancyEnablers(rel.available());
}            
  

Method Summary

Modifier and Type	Method	Description
RelevancyEnabler	getNextRelevancyEnabler()	Gets the next RelevancyEnabler in this list.
RelevancyEnabler[]	getNextRelevancyEnablers(long n)	Gets the next set of RelevancyEnabler elements in this list.

Methods inherited from interface Closeable

close

Methods inherited from interface OsidList

close

Modifier and Type	Method	Description
void	close()	Close this list.

Methods inherited from interface OsidList

available, hasNext, skip

Modifier and Type	Method	Description
long	available()	Gets the number of elements available for retrieval.
boolean	hasNext()	Tests if there are more elements in this list.
void	skip(long n)	Skip the specified number of elements in the list.

Method Details

getNextRelevancyEnabler

RelevancyEnabler getNextRelevancyEnabler()
                                  throws OperationFailedException

Gets the next RelevancyEnabler in this list.

Returns:

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

getNextRelevancyEnablers

RelevancyEnabler[] getNextRelevancyEnablers(long n)
                                     throws OperationFailedException

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

Parameters:

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

Returns:

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