ca.uhn.fhir.rest.annotation.OperationParam Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of hapi-fhir-base Show documentation
There is a newer version: 7.4.5
/*
 * #%L
 * HAPI FHIR - Core Library
 * %%
 * Copyright (C) 2014 - 2024 Smile CDR, Inc.
 * %%
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 * #L%
 */
package ca.uhn.fhir.rest.annotation;

import ca.uhn.fhir.model.primitive.StringDt;
import ca.uhn.fhir.rest.param.StringParam;
import org.hl7.fhir.instance.model.api.IBase;

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

/**
 */
@Retention(RetentionPolicy.RUNTIME)
@Target(value = ElementType.PARAMETER)
public @interface OperationParam {

	/**
	 * Value for {@link OperationParam#max()} indicating no maximum
	 */
	int MAX_UNLIMITED = -1;

	/**
	 * Value for {@link OperationParam#max()} indicating that the maximum will be inferred
	 * from the type. If the type is a single parameter type (e.g. StringDt,
	 * TokenParam, IBaseResource) the maximum will be
	 * 1.
	 * 
	 * If the type is a collection, e.g.
	 * List<StringDt> or List<TokenOrListParam>
	 * the maximum will be set to *. If the param is a search parameter
	 * "and" type, such as TokenAndListParam the maximum will also be
	 * set to *
	 * 
	 *
	 * @since 1.5
	 */
	int MAX_DEFAULT = -2;

	/**
	 * The name of the parameter
	 */
	String name();

	/**
	 * The type of the parameter. This will only have effect on @OperationParam
	 * annotations specified as values for {@link Operation#returnParameters()}, otherwise the
	 * value will be ignored. Value should be one of:
	 * 
	 * A resource type, e.g. Patient.class
	 * A datatype, e.g. {@link StringDt}.class or CodeableConceptDt.class
	 * 
A RESTful search parameter type, e.g. {@link StringParam}.class
	 * 
	 */
	Class type() default IBase.class;

	/**
	 * Optionally specifies the type of the parameter as a string, such as Coding or
	 * base64Binary. This can be useful if you want to use a generic interface type
	 * on the actual method,such as {@link org.hl7.fhir.instance.model.api.IPrimitiveType} or
	 * {@link @org.hl7.fhir.instance.model.api.ICompositeType}.
	 */
	String typeName() default "";

	/**
	 * The minimum number of repetitions allowed for this child (default is 0)
	 */
	int min() default 0;

	/**
	 * The maximum number of repetitions allowed for this child. Should be
	 * set to {@link #MAX_UNLIMITED} if there is no limit to the number of
	 * repetitions. See {@link #MAX_DEFAULT} for a description of the default
	 * behaviour.
	 */
	int max() default MAX_DEFAULT;
}