Interface | osid.relationship.FamilyList | ||
---|---|---|---|
Implements | osid.OsidList | ||
Description |
Like all while (fl.hasNext()) { Family family = fl.getNextFamily(); }or while (fl.hasNext()) { Family[] families = fl.getNextFamilies(fl.available()); } | ||
Method | getNextFamily | ||
Description |
Gets the next | ||
Return | osid.relationship.Family | the next Family in this list. The hasNext()
method should be used to test that a next Family is available
before calling this method. | |
Errors | ILLEGAL_STATE | no more elements available in this list | |
OPERATION_FAILED | unable to complete request | ||
Compliance | mandatory | This method must be implemented. | |
Method | getNextFamilies | ||
Description |
Gets the next set of | ||
Parameters | cardinal | n | the number of Family elements requested which must be less
than or equal to available() |
Return | osid.relationship.Family[] | an array of Family elements. The length of
the array is less than or equal to the number specified. | |
Errors | ILLEGAL_STATE | no more elements available in this list | |
OPERATION_FAILED | unable to complete request | ||
Compliance | mandatory | This method must be implemented. |