001package ca.uhn.fhir.rest.annotation;
002
003/*
004 * #%L
005 * HAPI FHIR - Core Library
006 * %%
007 * Copyright (C) 2014 - 2022 Smile CDR, Inc.
008 * %%
009 * Licensed under the Apache License, Version 2.0 (the "License");
010 * you may not use this file except in compliance with the License.
011 * You may obtain a copy of the License at
012 *
013 *      http://www.apache.org/licenses/LICENSE-2.0
014 *
015 * Unless required by applicable law or agreed to in writing, software
016 * distributed under the License is distributed on an "AS IS" BASIS,
017 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
018 * See the License for the specific language governing permissions and
019 * limitations under the License.
020 * #L%
021 */
022
023import java.lang.annotation.ElementType;
024import java.lang.annotation.Retention;
025import java.lang.annotation.RetentionPolicy;
026import java.lang.annotation.Target;
027
028import ca.uhn.fhir.model.api.IResource;
029
030/**
031 * RESTful method annotation to be used for the FHIR
032 * <a href="http://hl7.org/implement/standards/fhir/http.html#update">update</a> method.
033 * 
034 * <p>
035 * Update is used to save an update to an existing resource (using its ID and optionally
036 * a version ID). It also may allow a client to save a new resource using an ID of its choosing. 
037 * </p>
038 */
039@Retention(RetentionPolicy.RUNTIME)
040@Target(value=ElementType.METHOD)
041public @interface Update {
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 IResource> type() default IResource.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         * <p>
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
062}