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 ca.uhn.fhir.model.api.IResource;
029import ca.uhn.fhir.model.api.TagList;
030import ca.uhn.fhir.model.primitive.IdDt;
031
032/**
033 * RESTful method annotation to be used for the FHIR <a
034 * href="http://hl7.org/implement/standards/fhir/http.html#tags">Tag
035 * Operations</a> which have to do with adding tags.
036 * <ul>
037 * <li>
038 * To add tag(s) <b>to the given resource
039 * instance</b>, this annotation should contain a {@link #type()} attribute
040 * specifying the resource type, and the method should have a parameter of type
041 * {@link IdDt} annotated with the {@link IdParam} annotation, as well as 
042 * a parameter of type {@link TagList}. Note that this {@link TagList} parameter
043 * does not need to contain a complete list of tags for the resource, only a list
044 * of tags to be added. Server implementations must not remove tags based on this
045 * operation.
046 * Note that for a
047 * server implementation, the {@link #type()} annotation is optional if the
048 * method is defined in a <a href=
049 * "http://jamesagnew.github.io/hapi-fhir/doc_rest_server.html#resource_providers"
050 * >resource provider</a>, since the type is implied.</li>
051 * <li>
052 * To add tag(s) on the server <b>to the given version of the
053 * resource instance</b>, this annotation should contain a {@link #type()}
054 * attribute specifying the resource type, and the method should have a
055 * parameter of type {@link IdDt} annotated with the {@link VersionIdParam}
056 * annotation, <b>and</b> a parameter of type {@link IdDt} annotated with the
057 * {@link IdParam} annotation, as well as 
058 * a parameter of type {@link TagList}. Note that this {@link TagList} parameter
059 * does not need to contain a complete list of tags for the resource, only a list
060 * of tags to be added. Server implementations must not remove tags based on this
061 * operation.
062 * Note that for a server implementation, the
063 * {@link #type()} annotation is optional if the method is defined in a <a href=
064 * "http://jamesagnew.github.io/hapi-fhir/doc_rest_server.html#resource_providers"
065 * >resource provider</a>, since the type is implied.</li>
066 * </ul>
067 */
068@Target(value= ElementType.METHOD)
069@Retention(value=RetentionPolicy.RUNTIME)
070public @interface AddTags {
071
072        /**
073         * If set to a type other than the default (which is {@link IResource}
074         * , this method is expected to return a TagList containing only tags which
075         * are specific to the given resource type.
076         */
077        Class<? extends IResource> type() default IResource.class;
078
079}