OSID Logo
OSID Specifications
process package
Version 3.1.0
Interfaceosid.process.StateList
Implementsosid.OsidList
Used Byosid.control.Controller
osid.mapping.path.Signal
osid.process.StateAssignmentSession
osid.process.StateLookupSession
osid.process.StateQuerySession
osid.process.StateSearchResults
osid.process.StateSession
osid.workflow.Step
Description

Like all OsidLists, StateList provides a means for accessing State elements sequentially either one at a time or many at a time. Examples:

while (sl.hasNext()) {
     State state = sl.getNextState();
}
                
or
while (sl.hasNext()) {
     State[] states = sl.getNextStates(sl.available());
}
                
MethodgetNextState
Description

Gets the next State in this list.

Returnosid.process.State the next State in this list. The hasNext() method should be used to test that a next State is available before calling this method.
ErrorsILLEGAL_STATE no more elements available in this list
OPERATION_FAILED unable to complete request
Compliancemandatory This method must be implemented.
MethodgetNextStates
Description

Gets the next set of States in this list which must be less than or equal to the return from available().

Parameterscardinaln the number of State elements requested which must be less than or equal to available()
Returnosid.process.State[] an array of State elements. The length of the array is less than or equal to the number specified.
ErrorsILLEGAL_STATE no more elements available in this list
OPERATION_FAILED unable to complete request
Compliancemandatory This method must be implemented.