OSID Logo
OSID Specifications
hold package
Version 3.1.0
Interfaceosid.hold.OublietteList
Implementsosid.OsidList
Used Byosid.hold.BlockOublietteSession
osid.hold.HoldOublietteSession
osid.hold.IssueOublietteSession
osid.hold.OublietteHierarchySession
osid.hold.OublietteLookupSession
osid.hold.OublietteQuerySession
osid.hold.OublietteSearchResults
osid.hold.rules.HoldEnablerOublietteSession
osid.hold.rules.IssueConstrainerEnablerOublietteSession
osid.hold.rules.IssueConstrainerOublietteSession
show 4 more…
osid.hold.rules.IssueEnablerOublietteSession
osid.hold.rules.IssueProcessorEnablerOublietteSession
osid.hold.rules.IssueProcessorOublietteSession
osid.hold.rules.IssueProcessorSmartOublietteSession
Description

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

while (ol.hasNext()) {
     Oubliette oubliette = ol.getNextOubliette();
}
                
or
while (ol.hasNext()) {
     Oubliette[] oubliettes = ol.getNextOubliettes(ol.available());
}
                
MethodgetNextOubliette
Description

Gets the next Oubliette in this list.

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

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

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