001/*
002 * #%L
003 * HAPI FHIR - Core Library
004 * %%
005 * Copyright (C) 2014 - 2025 Smile CDR, Inc.
006 * %%
007 * Licensed under the Apache License, Version 2.0 (the "License");
008 * you may not use this file except in compliance with the License.
009 * You may obtain a copy of the License at
010 *
011 *      http://www.apache.org/licenses/LICENSE-2.0
012 *
013 * Unless required by applicable law or agreed to in writing, software
014 * distributed under the License is distributed on an "AS IS" BASIS,
015 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
016 * See the License for the specific language governing permissions and
017 * limitations under the License.
018 * #L%
019 */
020package ca.uhn.fhir.rest.gclient;
021
022import ca.uhn.fhir.rest.param.DateRangeParam;
023import org.hl7.fhir.instance.model.api.IPrimitiveType;
024
025import java.util.Date;
026
027public interface IHistoryTyped<T> extends IClientExecutable<IHistoryTyped<T>, T> {
028
029        /**
030         * Request that the server return only the history elements between the
031         * specific range
032         */
033        IHistoryTyped<T> at(DateRangeParam theDateRangeParam);
034
035        /**
036         * Request that the server return only up to <code>theCount</code> number of resources
037         */
038        IHistoryTyped<T> count(Integer theCount);
039
040        /**
041         * Request that the server return only resource versions that were created at or after the given time (inclusive)
042         * <p>
043         * Parameter theCutoff can be any priitive type which accepts a date, such as
044         * a <code>DateTimeDt</code>, <code>InstantType</code>, etc.
045         * </p>
046         */
047        IHistoryTyped<T> since(IPrimitiveType<Date> theCutoff);
048
049        /**
050         * Request that the server return only resource versions that were created at or after the given time (inclusive)
051         */
052        IHistoryTyped<T> since(Date theCutoff);
053
054        /**
055         * Requests that the server skips a number of resources and start at the specified element. Use
056         * with {@link #count(Integer)}.
057         */
058        IHistoryTyped<T> offset(Integer theOffset);
059}