OSID Logo
OSID Specifications
ordering package
Version 3.1.0
Interfaceosid.ordering.StoreList
Implementsosid.OsidList
Used Byosid.ordering.OrderStoreSession
osid.ordering.PriceScheduleStoreSession
osid.ordering.ProductStoreSession
osid.ordering.StoreHierarchySession
osid.ordering.StoreLookupSession
osid.ordering.StoreQuerySession
osid.ordering.StoreSearchResults
osid.ordering.rules.PriceEnablerStoreSession
Description

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

while (sl.hasNext()) {
     Store store = sl.getNextStore();
}
                
or
while (sl.hasNext()) {
     Store[] stores = sl.getNextStores(sl.available());
}
                
MethodgetNextStore
Description

Gets the next Store in this list.

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

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

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