001package ca.uhn.fhir.rest.gclient;
002
003/*
004 * #%L
005 * HAPI FHIR - Core Library
006 * %%
007 * Copyright (C) 2014 - 2016 University Health Network
008 * %%
009 * Licensed under the Apache License, Version 2.0 (the "License");
010 * you may not use this file except in compliance with the License.
011 * You may obtain a copy of the License at
012 * 
013 *      http://www.apache.org/licenses/LICENSE-2.0
014 * 
015 * Unless required by applicable law or agreed to in writing, software
016 * distributed under the License is distributed on an "AS IS" BASIS,
017 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
018 * See the License for the specific language governing permissions and
019 * limitations under the License.
020 * #L%
021 */
022
023import org.hl7.fhir.instance.model.api.IBaseBundle;
024
025import ca.uhn.fhir.model.api.Bundle;
026
027public interface IGetPage {
028
029        /**
030         * Load the next page of results using the link with relation "next" in the bundle. This
031         * method accepts a DSTU1 Atom Bundle
032         */
033        IGetPageTyped<Bundle> next(Bundle theBundle);
034        
035        /**
036         * Load the next page of results using the link with relation "next" in the bundle. This
037         * method accepts a DSTU2 Bundle resource
038         * 
039         * @since 1.1
040         */
041        <T extends IBaseBundle> IGetPageTyped<T> next(T theBundle);
042        
043        /**
044         * Load the previous page of results using the link with relation "previous" in the bundle. This
045         * method accepts a DSTU1 Atom Bundle
046         */
047        IGetPageTyped<Bundle> previous(Bundle theBundle);
048        
049        /**
050         * Load the previous page of results using the link with relation "prev" in the bundle. This
051         * method accepts a DSTU2+ Bundle resource
052         * 
053         * @since 1.1
054         */
055        <T extends IBaseBundle> IGetPageTyped<T> previous(T theBundle);
056
057        /**
058         * Load a page of results using the a given URL and return a DSTU1 Atom bundle
059         * 
060         * @deprecated Use {@link #byUrl(String)} instead
061         */
062        @Deprecated
063        IGetPageTyped<Bundle> url(String thePageUrl);
064        
065        /**
066         * Load a page of results using the a given URL and return a DSTU1 Atom bundle
067         */
068        IGetPageUntyped byUrl(String thePageUrl);
069
070}