Interface InstallationList

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

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

while (il.hasNext()) {
     Installation install = il.getNextInstallation();
}
or 
while (il.hasNext()) {
     Installation[] installs = il.getNextInstallations(il.available());
}

  • Method Summary

    Modifier and Type
    Method
    Description
    Installation
    getNextInstallation()
    Gets the next Installation in this list.
    Installation[]
    getNextInstallations(long n)
    Gets the next set of Installation elements in this list which must be less than or equal to the return from available() .

    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

    • getNextInstallation

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

    • getNextInstallations

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