Interface ProfileEntryAgentPeerList

All Superinterfaces:
AutoCloseable, Closeable, OsidList, OsidList
public interface ProfileEntryAgentPeerList extends OsidList

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

while (peapl.hasNext()) {
     ProfileEntryAgentPeer peer = peapl.getNextProfileEntryAgentPeer();
}
or 
while (peapl.hasNext()) {
     ProfileEntryAgentPeer[] peers = peapl.getNextProfileEntryAgentPeers(peapl.available());
}

  • Method Details

    • getNextProfileEntryAgentPeer

      ProfileEntryAgentPeer getNextProfileEntryAgentPeer() throws OperationFailedException
      Gets the next ProfileEntryAgentPeer in this list.
      Returns:
      the next ProfileEntryAgentPeer in this list. The hasNext() method should be used to test that a next ProfileEntryAgentPeer 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.

    • getNextProfileEntryAgentPeers

      ProfileEntryAgentPeer[] getNextProfileEntryAgentPeers(long n) throws OperationFailedException
      Gets the next set of ProfileEntryAgentPeer elements in this list. The specified amount must be less than or equal to the return from available() .
      Parameters:
      n - the number of ProfileEntryAgentPeer elements requested which must be less than or equal to available()
      Returns:
      an array of ProfileEntryAgentPeer 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.