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 */
019package org.apache.directory.api.ldap.model.message.controls;
020
021
022import org.apache.directory.api.ldap.model.message.Control;
023
024
025/**
026 * A persistence search object
027 *
028 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
029 */
030public interface PersistentSearch extends Control
031{
032    /** This control OID */
033    String OID = "2.16.840.1.113730.3.4.3";
034
035    /** Min and Max values for the possible combined change types */
036    int CHANGE_TYPES_MIN = ChangeType.ADD.getValue();
037
038    int CHANGE_TYPES_MAX = ChangeType.ADD.getValue()
039        | ChangeType.DELETE.getValue()
040        | ChangeType.MODIFY.getValue()
041        | ChangeType.MODDN.getValue();
042
043
044    void setChangesOnly( boolean changesOnly );
045
046
047    boolean isChangesOnly();
048
049
050    void setReturnECs( boolean returnECs );
051
052
053    boolean isReturnECs();
054
055
056    void setChangeTypes( int changeTypes );
057
058
059    int getChangeTypes();
060
061
062    boolean isNotificationEnabled( ChangeType changeType );
063
064
065    void enableNotification( ChangeType changeType );
066}