OSID Logo
OSID Specifications
workflow package
Version 3.1.0
Interfaceosid.workflow.WorkList
Implementsosid.OsidList
Used Byosid.workflow.WorkLookupSession
osid.workflow.WorkOfficeSession
osid.workflow.WorkQuerySession
osid.workflow.WorkSearchResults
osid.workflow.WorkflowInitiationSession
osid.workflow.WorkflowSession
Description

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

while (wl.hasNext()) {
     Work work = wl.getNextWork();
}
                
or
while (wl.hasNext()) {
     Work[] works = wl.getNextWorks(wl.available());
}
                
MethodgetNextWork
Description

Gets the next Work in this list.

Returnosid.workflow.Work the next Work in this list. The hasNext() method should be used to test that a next Work 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.
MethodgetNextWorks
Description

Gets the next set of Work elements in this list. The specified amount must be less than or equal to the return from available().

Parameterscardinaln the number of Work elements requested which must be less than or equal to available()
Returnosid.workflow.Work[] an array of Work 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.