Interface RegistrationTargetList

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

Like all OsidLists , RegistrationTarge tList provides a means for accessing RegistrationT arget elements sequentially either one at a time or many at a time. Examples: 

while (rtl.hasNext()) {
     RegistrationTarget registrationTarget = rtl.getNextRegistratio
nTarget();

} 

or

while (rtl.hasNext()) {
     RegistrationTarget[] registrationTargets = rtl.getNextRegistrationTargets(rtl.available());
}

  • Method Details

    • getNextRegistrationTarget

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

    • getNextRegistrationTargets

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