View Javadoc
1   package ca.uhn.fhir.rest.annotation;
2   
3   /*
4    * #%L
5    * HAPI FHIR - Core Library
6    * %%
7    * Copyright (C) 2014 - 2018 University Health Network
8    * %%
9    * Licensed under the Apache License, Version 2.0 (the "License");
10   * you may not use this file except in compliance with the License.
11   * You may obtain a copy of the License at
12   * 
13   *      http://www.apache.org/licenses/LICENSE-2.0
14   * 
15   * Unless required by applicable law or agreed to in writing, software
16   * distributed under the License is distributed on an "AS IS" BASIS,
17   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
18   * See the License for the specific language governing permissions and
19   * limitations under the License.
20   * #L%
21   */
22  
23  import java.lang.annotation.ElementType;
24  import java.lang.annotation.Retention;
25  import java.lang.annotation.RetentionPolicy;
26  import java.lang.annotation.Target;
27  
28  import org.hl7.fhir.instance.model.api.IBaseResource;
29  
30  /**
31   * RESTful method annotation to be used for the FHIR
32   * <a href="http://hl7.org/implement/standards/fhir/http.html#delete">delete</a> method.
33   * 
34   * <p>
35   * Delete is used to remove an existing resource, meaning that any attempts to
36   * do a non-version-specific read of that resource will fail.
37   * </p>
38   */
39  @Retention(RetentionPolicy.RUNTIME)
40  @Target(value=ElementType.METHOD)
41  public @interface Delete {
42  	
43  	/**
44  	 * The return type for this search method. This generally does not need
45  	 * to be populated for a server implementation, since servers will return
46  	 * only one resource per class, but generally does need to be populated
47  	 * for client implementations. 
48  	 */
49  	// NB: Read, Search (maybe others) share this annotation, so update the javadocs everywhere
50  	Class<? extends IBaseResource> type() default IBaseResource.class;	
51  }