001/*
002 * #%L
003 * HAPI FHIR - Core Library
004 * %%
005 * Copyright (C) 2014 - 2024 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 org.hl7.fhir.instance.model.api.IBaseResource;
023import org.hl7.fhir.instance.model.api.IIdType;
024
025public interface IBaseOn<T> {
026
027        /**
028         * Perform the operation across all versions of all resources of all types on the server
029         */
030        T onServer();
031
032        /**
033         * Perform the operation across all versions of all resources of the given type on the server
034         */
035        T onType(Class<? extends IBaseResource> theResourceType);
036
037        /**
038         * Perform the operation across all versions of all resources of the given type on the server
039         *
040         * @param theResourceType The resource type name, e.g. "ValueSet"
041         */
042        T onType(String theResourceType);
043
044        /**
045         * Perform the operation across all versions of a specific resource (by ID and type) on the server.
046         * Note that <code>theId</code> must be populated with both a resource type and a resource ID at
047         * a minimum.
048         *
049         * @throws IllegalArgumentException If <code>theId</code> does not contain at least a resource type and ID
050         */
051        T onInstance(IIdType theId);
052
053        /**
054         * Perform the operation across all versions of a specific resource (by ID and type) on the server.
055         * Note that <code>theId</code> must be populated with both a resource type and a resource ID at
056         * a minimum.
057         *
058         * @throws IllegalArgumentException If <code>theId</code> does not contain at least a resource type and ID
059         */
060        T onInstance(String theId);
061}