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.annotation;
021
022import org.hl7.fhir.instance.model.api.IBaseResource;
023
024import java.lang.annotation.ElementType;
025import java.lang.annotation.Retention;
026import java.lang.annotation.RetentionPolicy;
027import java.lang.annotation.Target;
028
029/**
030 * RESTful method annotation to be used for the proposed FHIR
031 * PATCH method
032 *
033 * <p>
034 * Patch is used to apply a differential to a resource in either
035 * XML or JSON format
036 * </p>
037 */
038@Retention(RetentionPolicy.RUNTIME)
039@Target({ElementType.METHOD})
040public @interface Patch {
041
042        /**
043         * The return type for this search method. This generally does not need
044         * to be populated for a server implementation, since servers will return
045         * only one resource per class, but generally does need to be populated
046         * for client implementations.
047         */
048        // NB: Read, Search (maybe others) share this annotation, so update the javadocs everywhere
049        Class<? extends IBaseResource> type() default IBaseResource.class;
050
051        /**
052         * This method allows the return type for this method to be specified in a
053         * non-type-specific way, using the text name of the resource, e.g. "Patient".
054         *
055         * This attribute should be populate, or {@link #type()} should be, but not both.
056         *
057         * @since 5.4.0
058         */
059        String typeName() default "";
060}