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