001package ca.uhn.fhir.rest.annotation;
002
003/*
004 * #%L
005 * HAPI FHIR - Core Library
006 * %%
007 * Copyright (C) 2014 - 2016 University Health Network
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 org.hl7.fhir.instance.model.api.IBaseResource;
029
030import ca.uhn.fhir.rest.client.api.IBasicClient;
031import ca.uhn.fhir.rest.client.api.IRestfulClient;
032import ca.uhn.fhir.rest.server.IResourceProvider;
033
034/**
035 * RESTful method annotation to be used for the FHIR <a href="http://hl7.org/implement/standards/fhir/http.html#read">read</a> and <a
036 * href="http://hl7.org/implement/standards/fhir/http.html#vread">vread</a> method.
037 * 
038 * <p>
039 * 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
040 * the method has only a parameter annotated with the {@link IdParam} annotation, it will be treated as a read operation.
041 * the
042 * </p>
043 * <p>
044 * If you wish for your server to support both read and vread operations, you will need
045 * two methods annotated with this annotation.
046 * </p>
047 */
048@Retention(RetentionPolicy.RUNTIME)
049@Target(ElementType.METHOD)
050public @interface Read {
051
052        /**
053         * The return type for this method. This generally does not need to be populated for {@link IResourceProvider resource providers} in a server implementation, but often does need to be populated in
054         * client implementations using {@link IBasicClient} or {@link IRestfulClient}, or in plain providers on a server.
055         * <p>
056         * 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
057         * <code>Patient</code> or <code>List&lt;Patient&gt;</code>, the server/client will automatically determine that the Patient resource is the return type, and this value may be left blank.
058         * </p>
059         */
060        // NB: Read, Search (maybe others) share this annotation, so update the javadocs everywhere
061        Class<? extends IBaseResource> type() default IBaseResource.class;
062
063        /**
064         * If set to true (default is false), this method supports vread operation as well as read
065         */
066        boolean version() default false;
067
068}