Interface ProfileEntryResourcePeerList

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

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

while (perpl.hasNext()) {
     ProfileEntryResourcePeer peer = perpl.getNextProfileEntryResourcePeer();
}
or 
while (perpl.hasNext()) {
     ProfileEntryResourcePeer[] peers = perpl.getNextProfileEntryResourcePeers(perpl.available());
}

  • Method Details

    • getNextProfileEntryResourcePeer

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

    • getNextProfileEntryResourcePeers

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