ca.uhn.fhir.rest.gclient.IDelete Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of hapi-fhir-base Show documentation

Builds the hapi fhir base. Requires Common lang, commons-text, and guava be built first.

There is a newer version: 7.0.2-r12

/*
 * #%L
 * HAPI FHIR - Core Library
 * %%
 * Copyright (C) 2014 - 2024 Smile CDR, Inc.
 * %%
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 * #L%
 */
package ca.uhn.fhir.rest.gclient;

import org.hl7.fhir.instance.model.api.IBaseResource;
import org.hl7.fhir.instance.model.api.IIdType;

public interface IDelete {

	IDeleteTyped resource(IBaseResource theResource);

	IDeleteTyped resourceById(IIdType theId);

	IDeleteTyped resourceById(String theResourceType, String theLogicalId);

	/**
	 * Specifies that the delete should be performed as a conditional delete
	 * against a given search URL.
	 *
	 * @param theSearchUrl The search URL to use. The format of this URL should be of the form [ResourceType]?[Parameters],
	 *                     for example: Patient?name=Smith&identifier=13.2.4.11.4%7C847366
	 * @since HAPI 0.9 / FHIR DSTU 2
	 */
	IDeleteTyped resourceConditionalByUrl(String theSearchUrl);

	/**
	 * Delete using a conditional/match URL. The query parameters will be added in the next part of the call chain.
	 * @since HAPI 0.9 / FHIR DSTU 2
	 */
	IDeleteWithQuery resourceConditionalByType(String theResourceType);

	/**
	 * Delete using a conditional/match URL. The query parameters will be added in the next part of the call chain.
	 * @since HAPI 1.3
	 */
	IDeleteWithQuery resourceConditionalByType(Class theResourceType);
}