OSID Logo
OSID Specifications
mapping path rules package
Version 3.1.0
Interfaceosid.mapping.path.rules.ObstacleEnablerList
Implementsosid.OsidList
Used Byosid.mapping.path.rules.ObstacleEnablerLookupSession
osid.mapping.path.rules.ObstacleEnablerMapSession
osid.mapping.path.rules.ObstacleEnablerQuerySession
osid.mapping.path.rules.ObstacleEnablerRuleLookupSession
osid.mapping.path.rules.ObstacleEnablerSearchResults
Description

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

while (oel.hasNext()) {
     ObstacleEnabler enabler = oel.getNextObstacleEnabler();
}
                
or
while (oel.hasNext()) {
     ObstacleEnabler[] enablers = oel.getNextObstacleEnablers(oel.available());
}
                
MethodgetNextObstacleEnabler
Description

Gets the next ObstacleEnabler in this list.

Returnosid.mapping.path.rules.ObstacleEnabler the next ObstacleEnabler in this list. The hasNext() method should be used to test that a next ObstacleEnabler 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.
MethodgetNextObstacleEnablers
Description

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

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