/*
 *  Licensed to the Apache Software Foundation (ASF) under one
 *  or more contributor license agreements.  See the NOTICE file
 *  distributed with this work for additional information
 *  regarding copyright ownership.  The ASF licenses this file
 *  to you under the Apache License, Version 2.0 (the
 *  "License"); you may not use this file except in compliance
 *  with the License.  You may obtain a copy of the License at
 *  
 *    https://www.apache.org/licenses/LICENSE-2.0
 *  
 *  Unless required by applicable law or agreed to in writing,
 *  software distributed under the License is distributed on an
 *  "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 *  KIND, either express or implied.  See the License for the
 *  specific language governing permissions and limitations
 *  under the License. 
 *  
 */
package org.apache.directory.api.ldap.extras.controls.syncrepl.syncRequest;


import org.apache.directory.api.ldap.extras.controls.SynchronizationModeEnum;
import org.apache.directory.api.ldap.model.message.Control;


/**
 * A syncRequestValue object, as defined in RFC 4533
 * 
 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
 */
public interface SyncRequestValue extends Control
{
    /** This control OID */
    String OID = "1.3.6.1.4.1.4203.1.9.1.1";


    /**
     * Get the mode
     * 
     * @return the mode
     */
    SynchronizationModeEnum getMode();


    /**
     * Set the mode
     * 
     * @param mode the syncMode to set
     */
    void setMode( SynchronizationModeEnum mode );


    /**
     * Get the cookie
     * 
     * @return the cookie
     */
    byte[] getCookie();


    /**
     * Set the cookie
     * 
     * @param cookie the cookie to set
     */
    void setCookie( byte[] cookie );


    /**
     * Get the reloadHint flag
     * 
     * @return the reloadHint
     */
    boolean isReloadHint();


    /**
     * Set the reloadHint flag
     * 
     * @param reloadHint the reloadHint to set
     */
    void setReloadHint( boolean reloadHint );

}
