OSID Logo
OSID Specifications
hold package
Version 3.1.0
Interfaceosid.hold.HoldList
Implementsosid.OsidList
Used Byosid.hold.HoldLookupSession
osid.hold.HoldOublietteSession
osid.hold.HoldQuerySession
osid.hold.HoldSearchResults
osid.hold.MyHoldSession
osid.hold.rules.HoldEnablerRuleLookupSession
Description

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

while (hl.hasNext()) {
     Hold hold = hl.getNextHold();
}
                
or
while (hl.hasNext()) {
     Hold[] holds = hl.getNextHolds(hl.available());
}
                
MethodgetNextHold
Description

Gets the next Hold in this list.

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

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

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