OSID Logo
OSID Specifications
resourcing package
Version 3.1.0
Interfaceosid.resourcing.EffortList
Implementsosid.OsidList
Used Byosid.resourcing.EffortFoundrySession
osid.resourcing.EffortLookupSession
osid.resourcing.EffortQuerySession
osid.resourcing.EffortSearchResults
osid.resourcing.MyWorkSession
Description

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

while (el.hasNext()) {
     Effort effort = el.getNextEffort();
}
                
or
while (el.hasNext()) {
     Effort[] efforts = el.getNextEfforts(el.available());
}
                
MethodgetNextEffort
Description

Gets the next Effort in this list.

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

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

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