View Javadoc
1   package ca.uhn.fhir.rest.gclient;
2   
3   /*
4    * #%L
5    * HAPI FHIR - Core Library
6    * %%
7    * Copyright (C) 2014 - 2018 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  public interface ISort<T> {
24  
25  	/**
26  	 * Sort ascending 
27  	 */
28  	IQuery<T> ascending(IParam theParam);
29  
30  	/**
31  	 * Sort ascending 
32  	 * 
33  	 * @param theParam The param name, e.g. "address"
34  	 */
35  	IQuery<T> ascending(String theParam);
36  
37  	/**
38  	 * Sort by the default order. Note that as of STU3, there is no longer
39  	 * a concept of default order, only ascending and descending. This method
40  	 * technically implies "ascending" but it makes more sense to use 
41  	 * {@link #ascending(IParam)}
42  	 */
43  	IQuery<T> defaultOrder(IParam theParam);
44  
45  	/**
46  	 * Sort descending
47  	 * 
48  	 * @param theParam A query param - Could be a constant such as <code>Patient.ADDRESS</code> or a custom 
49  	 * param such as <code>new StringClientParam("foo")</code>
50  	 */
51  	IQuery<T> descending(IParam theParam);
52  	
53  	/**
54  	 * Sort ascending 
55  	 * 
56  	 * @param theParam The param name, e.g. "address"
57  	 */
58  	IQuery<T> descending(String theParam);
59  
60  }