org.apache.directory.api.ldap.model.entry.Modification Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of api-ldap-client-all
There is a newer version: 2.1.6
/*
 *  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
 *  
 *    http://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.model.entry;


import java.io.Externalizable;

import org.apache.directory.api.ldap.model.exception.LdapInvalidAttributeValueException;
import org.apache.directory.api.ldap.model.schema.AttributeType;


/**
 * An internal interface for a ModificationItem. The name has been
 * chosen so that it does not conflict with @see ModificationItem
 *
 * @author Apache Directory Project
 */
public interface Modification extends Cloneable, Externalizable
{
    /**
     *  @return the operation
     */
    ModificationOperation getOperation();


    /**
     * Store the modification operation
     *
     * @param operation The DirContext value to assign
     */
    void setOperation( int operation );


    /**
     * Store the modification operation
     *
     * @param operation The ModificationOperation value to assign
     */
    void setOperation( ModificationOperation operation );


    /**
     * @return the attribute containing the modifications
     */
    Attribute getAttribute();


    /**
     * Set the attribute's modification
     *
     * @param attribute The modified attribute
     */
    void setAttribute( Attribute attribute );


    /**
     * The clone operation
     *
     * @return a clone of the current modification
     */
    Modification clone();


    /**
     * Apply the AttributeType to the Modification
     * 
     * @param attributeType the injected AttributeType
     * @throws LdapInvalidAttributeValueException If the Modification is invalid
     */
    void apply( AttributeType attributeType ) throws LdapInvalidAttributeValueException;
}