| Interface | osid.calendaring.CommitmentList | ||
|---|---|---|---|
| Implements | osid.OsidList | ||
| Description |
Like all
while (cl.hasNext()) {
Commitment commitment = cl.getNextCommitment();
}
or
while (cl.hasNext()) {
Commitment[] commitments = cl.getNextCommitment(cl.available());
}
| ||
| Method | getNextCommitment | ||
| Description |
Gets the next | ||
| Return | osid.calendaring.Commitment | the next Commitment in this list. The hasNext()
method should be used to test that a next Commitment 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 | getNextCommitments | ||
| Description |
Gets the next set of | ||
| Parameters | cardinal | n | the number of Commitment elements requested which should be
less than or equal to available() |
| Return | osid.calendaring.Commitment[] | an array of Commitment 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. | |