1 package ca.uhn.fhir.rest.annotation;
2
3 /*
4 * #%L
5 * HAPI FHIR - Core Library
6 * %%
7 * Copyright (C) 2014 - 2019 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 ca.uhn.fhir.rest.api.SortSpec;
29
30 /**
31 * For searches, a parameter may be annotated with the {@link Sort} annotation. The
32 * parameter should be of type {@link SortSpec}.
33 *
34 * <p>
35 * Note that if you wish to chain
36 * multiple sort parameters (i.e. a sub sort), you should use the {@link SortSpec#setChain(SortSpec)}
37 * method. Multiple parameters should not be annotated with the Sort annotation.
38 * </p>
39 *
40 * @see Search
41 */
42 @Target(value=ElementType.PARAMETER)
43 @Retention(RetentionPolicy.RUNTIME)
44 public @interface Sort {
45 // nothing
46 }