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 IDelete {
026
027        IDeleteTyped resource(IBaseResource theResource);
028
029        IDeleteTyped resourceById(IIdType theId);
030
031        IDeleteTyped resourceById(String theResourceType, String theLogicalId);
032
033        /**
034         * Specifies that the delete should be performed as a conditional delete
035         * against a given search URL.
036         *
037         * @param theSearchUrl The search URL to use. The format of this URL should be of the form <code>[ResourceType]?[Parameters]</code>,
038         *                     for example: <code>Patient?name=Smith&amp;identifier=13.2.4.11.4%7C847366</code>
039         * @since HAPI 0.9 / FHIR DSTU 2
040         */
041        IDeleteTyped resourceConditionalByUrl(String theSearchUrl);
042
043        /**
044         * Delete using a conditional/match URL. The query parameters will be added in the next part of the call chain.
045         * @since HAPI 0.9 / FHIR DSTU 2
046         */
047        IDeleteWithQuery resourceConditionalByType(String theResourceType);
048
049        /**
050         * Delete using a conditional/match URL. The query parameters will be added in the next part of the call chain.
051         * @since HAPI 1.3
052         */
053        IDeleteWithQuery resourceConditionalByType(Class<? extends IBaseResource> theResourceType);
054}