001/* 002 * Licensed to the Apache Software Foundation (ASF) under one 003 * or more contributor license agreements. See the NOTICE file 004 * distributed with this work for additional information 005 * regarding copyright ownership. The ASF licenses this file 006 * to you under the Apache License, Version 2.0 (the 007 * "License"); you may not use this file except in compliance 008 * with the License. You may obtain a copy of the License at 009 * 010 * http://www.apache.org/licenses/LICENSE-2.0 011 * 012 * Unless required by applicable law or agreed to in writing, 013 * software distributed under the License is distributed on an 014 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 015 * KIND, either express or implied. See the License for the 016 * specific language governing permissions and limitations 017 * under the License. 018 * 019 */ 020package org.apache.directory.api.ldap.model.message.controls; 021 022 023import java.util.List; 024 025import org.apache.directory.api.ldap.model.message.Control; 026 027 028/** 029 * Implementation of Server Side Sort request control based on 030 * the <a href="http://tools.ietf.org/html/rfc2891">RFC 2891</a><br><br> 031 * 032 * SortKeyList ::= SEQUENCE OF SEQUENCE {<br> 033 * attributeType AttributeDescription,<br> 034 * orderingRule [0] MatchingRuleId OPTIONAL,<br> 035 * reverseOrder [1] BOOLEAN DEFAULT FALSE }<br> 036 * 037 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a> 038 */ 039public interface SortRequest extends Control 040{ 041 /** the sort request control's OID */ 042 String OID = "1.2.840.113556.1.4.473"; 043 044 045 /** 046 * sets the sort keys 047 * 048 * @param sortKeys The list of keys to be sorted 049 */ 050 void setSortKeys( List<SortKey> sortKeys ); 051 052 053 /** 054 * @return the list of sort keys 055 */ 056 List<SortKey> getSortKeys(); 057 058 059 /** 060 * adds a sort key 061 * 062 * @param sortKey The list of keys to be sorted 063 */ 064 void addSortKey( SortKey sortKey ); 065}