1 /*
2 * Licensed to the Apache Software Foundation (ASF) under one
3 * or more contributor license agreements. See the NOTICE file
4 * distributed with this work for additional information
5 * regarding copyright ownership. The ASF licenses this file
6 * to you under the Apache License, Version 2.0 (the
7 * "License"); you may not use this file except in compliance
8 * with the License. You may obtain a copy of the License at
9 *
10 * http://www.apache.org/licenses/LICENSE-2.0
11 *
12 * Unless required by applicable law or agreed to in writing,
13 * software distributed under the License is distributed on an
14 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15 * KIND, either express or implied. See the License for the
16 * specific language governing permissions and limitations
17 * under the License.
18 *
19 */
20 package org.apache.directory.api.ldap.model.message.controls;
21
22
23 import java.util.List;
24
25 import org.apache.directory.api.ldap.model.message.Control;
26
27
28 /**
29 * Implementation of Server Side Sort request control based on
30 * the <a href="http://tools.ietf.org/html/rfc2891">RFC 2891</a><br><br>
31 *
32 * SortKeyList ::= SEQUENCE OF SEQUENCE {<br>
33 * attributeType AttributeDescription,<br>
34 * orderingRule [0] MatchingRuleId OPTIONAL,<br>
35 * reverseOrder [1] BOOLEAN DEFAULT FALSE }<br>
36 *
37 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
38 */
39 public interface SortRequest extends Control
40 {
41 /** the sort request control's OID */
42 String OID = "1.2.840.113556.1.4.473";
43
44
45 /**
46 * sets the sort keys
47 *
48 * @param sortKeys
49 */
50 void setSortKeys( List<SortKey> sortKeys );
51
52
53 /**
54 * @return the list of sort keys
55 */
56 List<SortKey> getSortKeys();
57
58
59 /**
60 * adds a sort key
61 *
62 * @param sortKey
63 */
64 void addSortKey( SortKey sortKey );
65 }