001package ca.uhn.fhir.rest.server;
002
003import ca.uhn.fhir.rest.api.server.IBundleProvider;
004
005/*
006 * #%L
007 * HAPI FHIR - Server Framework
008 * %%
009 * Copyright (C) 2014 - 2019 University Health Network
010 * %%
011 * Licensed under the Apache License, Version 2.0 (the "License");
012 * you may not use this file except in compliance with the License.
013 * You may obtain a copy of the License at
014 * 
015 *      http://www.apache.org/licenses/LICENSE-2.0
016 * 
017 * Unless required by applicable law or agreed to in writing, software
018 * distributed under the License is distributed on an "AS IS" BASIS,
019 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
020 * See the License for the specific language governing permissions and
021 * limitations under the License.
022 * #L%
023 */
024
025public interface IPagingProvider {
026
027        int getDefaultPageSize();
028
029        int getMaximumPageSize();
030
031        /**
032         * Retrieve a result list by ID
033         */
034        IBundleProvider retrieveResultList(String theSearchId);
035
036        /**
037         * Retrieve a result list by ID
038         */
039        default IBundleProvider retrieveResultList(String theSearchId, String thePageId) {
040                return null;
041        }
042
043        /**
044         * Stores a result list and returns an ID with which that list can be returned
045         */
046        String storeResultList(IBundleProvider theList);
047
048}