public interface ProfileItemList extends OsidList
Like all OsidLists,
ProfileItemList
provides a means for accessing ProfileItem
elements
sequentially either one at a time or many at a time. Examples:
while (pil.hasNext()) { ProfileItem item = pil.getNextProfileItem(); }or
while (pil.hasNext()) { ProfileItem[] items = pil.getNextProfileItems(pil.available()); }
Modifier and Type | Method and Description |
---|---|
ProfileItem |
getNextProfileItem()
Gets the next
ProfileItem in this list. |
ProfileItem[] |
getNextProfileItems(long n)
Gets the next set of
ProfileItem elements in this list
which must be less than or equal to the number returned from
available(). |
ProfileItem getNextProfileItem() throws OperationFailedException
ProfileItem
in this list. ProfileItem
in this list. The
hasNext()
method should be used to test that a next
ProfileItem
is available before calling this
method.IllegalStateException
- no more elements available in
this listOperationFailedException
- unable to complete requestmandatory
- This method must be implemented. ProfileItem[] getNextProfileItems(long n) throws OperationFailedException
ProfileItem
elements in this list
which must be less than or equal to the number returned from
available().
n
- the number of ProfileItem
elements requested
which should be less than or equal to available()
ProfileItem
elements.
The length of the array is less than or equal to the
number specified.IllegalStateException
- no more elements available in
this listOperationFailedException
- unable to complete requestmandatory
- This method must be implemented.