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.ElementType;
024import java.lang.annotation.Retention;
025import java.lang.annotation.RetentionPolicy;
026import java.lang.annotation.Target;
027
028/**
029 * On the {@link Update}, {@link Create} and {@link Delete} operation methods, this annotation
030 * can be used to mark a {@link String} parameter which will be populated with the 
031 * conditional "search" URL for the operation, if an incoming client invocation is
032 * a conditional operation. For non-conditional invocations, the value will be set to
033 * <code>null</code> so it is important to handle <code>null</code>.
034 * <p>
035 * Parameters annotated with this annotation <b>must be of type {@link String}</b>
036 * </p>
037 */
038@Retention(RetentionPolicy.RUNTIME)
039@Target(ElementType.PARAMETER)
040public @interface ConditionalUrlParam {
041
042        /**
043         * Does this param support operating over multiple objects without throwing an error? This
044         * should be set to <code>true</code> only for conditional delete operations if the server
045         * supports multiple deletes via a conditional URL.
046         * <p>
047         * Note that this flag is only a hint to the Conformance statement generator,
048         * it does not actually affect how the server itself works.
049         * </p>  
050         */
051        boolean supportsMultiple() default false;
052        
053}