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 package org.apache.directory.api.ldap.model.message.controls;
20
21
22 import org.apache.directory.api.ldap.model.message.Control;
23
24
25 /**
26 * A persistence search object
27 *
28 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
29 */
30 public interface PersistentSearch extends Control
31 {
32 /** This control OID */
33 String OID = "2.16.840.1.113730.3.4.3";
34
35 /** Min and Max values for the possible combined change types */
36 int CHANGE_TYPES_MIN = ChangeType.ADD.getValue();
37
38 int CHANGE_TYPES_MAX = ChangeType.ADD.getValue()
39 | ChangeType.DELETE.getValue()
40 | ChangeType.MODIFY.getValue()
41 | ChangeType.MODDN.getValue();
42
43
44 void setChangesOnly( boolean changesOnly );
45
46
47 boolean isChangesOnly();
48
49
50 void setReturnECs( boolean returnECs );
51
52
53 boolean isReturnECs();
54
55
56 void setChangeTypes( int changeTypes );
57
58
59 int getChangeTypes();
60
61
62 boolean isNotificationEnabled( ChangeType changeType );
63
64
65 void enableNotification( ChangeType changeType );
66 }