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 org.hl7.fhir.instance.model.api.IBaseResource;
023import org.hl7.fhir.instance.model.api.IIdType;
024
025public interface IPatchWithBody extends IPatchExecutable {
026
027        /**
028         * Build a conditional URL using fluent constants on resource types
029         *
030         * @param theResourceType
031         *           The resource type to patch (e.g. "Patient.class")
032         */
033        IPatchWithQuery conditional(Class<? extends IBaseResource> theResourceType);
034
035        /**
036         * Build a conditional URL using fluent constants on resource types
037         *
038         * @param theResourceType
039         *           The resource type to patch (e.g. "Patient")
040         */
041        IPatchWithQuery conditional(String theResourceType);
042
043        /**
044         * Specifies that the update should be performed as a conditional create
045         * against a given search URL.
046         *
047         * @param theSearchUrl
048         *           The search URL to use. The format of this URL should be of the form <code>[ResourceType]?[Parameters]</code>,
049         *           for example: <code>Patient?name=Smith&amp;identifier=13.2.4.11.4%7C847366</code>
050         */
051        IPatchExecutable conditionalByUrl(String theSearchUrl);
052
053        /**
054         * The resource ID to patch (must include both a resource type and an ID, e.g. <code>Patient/123</code>)
055         */
056        IPatchExecutable withId(IIdType theId);
057
058        /**
059         * The resource ID to patch (must include both a resource type and an ID, e.g. <code>Patient/123</code>)
060         */
061        IPatchExecutable withId(String theId);
062}