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