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