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