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