OSID Logo
OSID Specifications
lexicon package
Version 3.0.0
Interfaceosid.lexicon.PressList
Implementsosid.OsidList
Used Byosid.lexicon.IdiomPressSession
osid.lexicon.ParameterPressSession
osid.lexicon.PressHierarchySession
osid.lexicon.PressLookupSession
osid.lexicon.PressQuerySession
osid.lexicon.PressSearchResults
osid.lexicon.TextPressSession
Description

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

while (pl.hasNext()) {
     Press press = pl.getNextPress();
}            
                
or
while (pl.hasNext()) {
     Press[] presses = pl.getNextPresses([l.available());
}            
                
MethodgetNextPress
Description

Gets the next Press in this list.

Returnosid.lexicon.Pressthe next Press in this list. The hasNext() method should be used to test that a next Press is available before calling this method.
ErrorsILLEGAL_STATEno more elements available in this list
OPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodgetNextPresses
Description

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

Parameterscardinalnthe number of Press elements requested which must be less than or equal to available()
Returnosid.lexicon.Press[]an array of Press elements. The length of the array is less than or equal to the number specified.
ErrorsILLEGAL_STATEno more elements available in this list
OPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.