
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 */ 022import java.lang.annotation.*; 023 024import org.hl7.fhir.instance.model.api.IBaseResource; 025 026import ca.uhn.fhir.rest.client.api.IBasicClient; 027import ca.uhn.fhir.rest.client.api.IRestfulClient; 028 029/** 030 * RESTful method annotation to be used for the FHIR <a href="http://hl7.org/implement/standards/fhir/http.html#read">read</a> and <a 031 * href="http://hl7.org/implement/standards/fhir/http.html#vread">vread</a> method. 032 * 033 * <p> 034 * If this method has a parameter annotated with the {@link IdParam} annotation and a parameter annotated with the {@link VersionIdParam} annotation, the method will be treated as a vread method. If 035 * the method has only a parameter annotated with the {@link IdParam} annotation, it will be treated as a read operation. 036 * the 037 * </p> 038 * <p> 039 * If you wish for your server to support both read and vread operations, you will need 040 * two methods annotated with this annotation. 041 * </p> 042 */ 043@Retention(RetentionPolicy.RUNTIME) 044@Target(ElementType.METHOD) 045public @interface Read { 046 047 /** 048 * The return type for this method. This generally does not need to be populated for IResourceProvider in a server implementation, but often does need to be populated in 049 * client implementations using {@link IBasicClient} or {@link IRestfulClient}, or in plain providers on a server. 050 * <p> 051 * This value also does not need to be populated if the return type for a method annotated with this annotation is sufficient to determine the type of resource provided. E.g. if the method returns 052 * <code>Patient</code> or <code>List<Patient></code>, the server/client will automatically determine that the Patient resource is the return type, and this value may be left blank. 053 * </p> 054 */ 055 // NB: Read, Search (maybe others) share this annotation, so update the javadocs everywhere 056 Class<? extends IBaseResource> type() default IBaseResource.class; 057 058 /** 059 * This method allows the return type for this method to be specified in a 060 * non-type-specific way, using the text name of the resource, e.g. "Patient". 061 * 062 * This attribute should be populate, or {@link #type()} should be, but not both. 063 * 064 * @since 5.4.0 065 */ 066 String typeName() default ""; 067 068 /** 069 * If set to true (default is false), this method supports vread operation as well as read 070 */ 071 boolean version() default false; 072}