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