001package ca.uhn.fhir.rest.annotation;
002
003/*
004 * #%L
005 * HAPI FHIR - Core Library
006 * %%
007 * Copyright (C) 2014 - 2021 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
028import ca.uhn.fhir.rest.api.SortSpec;
029
030/**
031 * For searches, a parameter may be annotated with the {@link Sort} annotation. The 
032 * parameter should be of type {@link SortSpec}. 
033 * 
034 * <p>
035 * Note that if you wish to chain
036 * multiple sort parameters (i.e. a sub sort), you should use the {@link SortSpec#setChain(SortSpec)}
037 * method. Multiple parameters should not be annotated with the Sort annotation.
038 * </p>
039 *   
040 * @see Search
041 */
042@Target(value=ElementType.PARAMETER)
043@Retention(RetentionPolicy.RUNTIME)
044public @interface Sort {
045        // nothing
046}