Interface OrganizationList

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

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

while (ol.hasNext()) {
     Organization organization = ol.getNextOrganization();
}
or 
while (ol.hasNext()) {
     Organization[] organizations = ol.getNextOrganizations(ol.available());
}

  • Method Summary

    Modifier and Type
    Method
    Description
    Organization
    getNextOrganization()
    Gets the next Organization in this list.
    Organization[]
    getNextOrganizations(long n)
    Gets the next set of Organization 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

    • getNextOrganization

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

    • getNextOrganizations

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