/**
 * Replication Benchmarker
 * https://github.com/score-team/replication-benchmarker/
 * Copyright (C) 2013 LORIA / Inria / SCORE Team
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */
package jbenchmarker.ot.soct2;

import collect.VectorClock;
import crdt.Factory;
import crdt.Operation;

/**
 *
 * @author urso
 */
public interface OTAlgorithm<O extends Operation> extends Factory<OTAlgorithm<O>> {

    /**
     * This method put on operation the vector clock, increse the vector clock
     * the operation is not applyed
     * @param op The operation
     * @return Soct2Message with vector clock.
     */
    OTMessage estampileMessage(Operation op);

    /**
     * @return return log object
     */
    SOCT2Log getLog();

    /**
     *
     * @return the vector clock of the instance
     */
    VectorClock getSiteVC();

    /**
     * Integre operation sent by another site or replicats.
     * The operation is returned to apply on document
     * @param soct2message Is a message which contains the operation and vector clock
     * @return operation to performe on document
     */
    O integrateRemote(OTMessage soct2message);

    /**
     * Check if the operation is ready by its vector clock
     * @param siteId Site of operation
     * @param vcOp Vector clock of this operation.
     * @return true if its ready false else.
     */
    boolean readyFor(int siteId, VectorClock vcOp);

    void setReplicaNumber(int siteId);

    public int getReplicaNumber();
    
    public SOCT2TranformationInterface<O> getTransformation();
}