public interface ProfileList extends OsidList
Like all OsidLists,
ProfileList
provides
a means for accessing Profile
elements sequentially either
one at a time or many at a time. Examples:
while (pl.hasNext()) { Profile profile = pl.getNextProfile(); }or
while (pl.hasNext()) { Profile[] profiles = pl.getNextProfiles(pl.available()); }
Modifier and Type | Method and Description |
---|---|
Profile |
getNextProfile()
Gets the next
Profile in this list. |
Profile[] |
getNextProfiles(long n)
Gets the next set of
Profile elements in this list
which must be less than or equal to the return from
available(). |
Profile getNextProfile() throws OperationFailedException
Profile
in this list. Profile
in this list. The
hasNext()
method should be used to test that a next
Profile
is available before calling this
method.IllegalStateException
- no more elements available in
this listOperationFailedException
- unable to complete requestmandatory
- This method must be implemented. Profile[] getNextProfiles(long n) throws OperationFailedException
Profile
elements in this list
which must be less than or equal to the return from
available().
n
- the number of Profile
elements requested
which must be less than or equal to available()
Profile
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.