001/*
002 * #%L
003 * HAPI FHIR - Core Library
004 * %%
005 * Copyright (C) 2014 - 2024 Smile CDR, Inc.
006 * %%
007 * Licensed under the Apache License, Version 2.0 (the "License");
008 * you may not use this file except in compliance with the License.
009 * You may obtain a copy of the License at
010 *
011 *      http://www.apache.org/licenses/LICENSE-2.0
012 *
013 * Unless required by applicable law or agreed to in writing, software
014 * distributed under the License is distributed on an "AS IS" BASIS,
015 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
016 * See the License for the specific language governing permissions and
017 * limitations under the License.
018 * #L%
019 */
020package ca.uhn.fhir.rest.annotation;
021
022import java.lang.annotation.ElementType;
023import java.lang.annotation.Retention;
024import java.lang.annotation.RetentionPolicy;
025import java.lang.annotation.Target;
026
027/**
028 * On the {@link Update}, {@link Create} and {@link Delete} operation methods, this annotation
029 * can be used to mark a {@link String} parameter which will be populated with the
030 * conditional "search" URL for the operation, if an incoming client invocation is
031 * a conditional operation. For non-conditional invocations, the value will be set to
032 * <code>null</code> so it is important to handle <code>null</code>.
033 * <p>
034 * Parameters annotated with this annotation <b>must be of type {@link String}</b>
035 * </p>
036 */
037@Retention(RetentionPolicy.RUNTIME)
038@Target(ElementType.PARAMETER)
039public @interface ConditionalUrlParam {
040
041        /**
042         * Does this param support operating over multiple objects without throwing an error? This
043         * should be set to <code>true</code> only for conditional delete operations if the server
044         * supports multiple deletes via a conditional URL.
045         * <p>
046         * Note that this flag is only a hint to the Conformance statement generator,
047         * it does not actually affect how the server itself works.
048         * </p>
049         */
050        boolean supportsMultiple() default false;
051}