/*
 * Copyright (c) 2016 Cisco Systems, Inc. and others.  All rights reserved.
 *
 * This program and the accompanying materials are made available under the
 * terms of the Eclipse Public License v1.0 which accompanies this distribution,
 * and is available at http://www.eclipse.org/legal/epl-v10.html
 */

package org.opendaylight.mdsal.binding.api;

import org.opendaylight.yangtools.concepts.ObjectRegistration;
import org.opendaylight.yangtools.yang.binding.DataObject;

/**
 *
 * Commit Cohort registry.
 *
 * See {@link DataTreeCommitCohort} for more details.
 *
 * @author Tony Tkacik <ttkacik@cisco.com>
 *
 */
public interface DataTreeCommitCohortRegistry {

    /**
     * Register commit cohort which will participate in three-phase commit protocols of write
     * transaction in data broker associated with this instance of extension.
     *
     * @param subtree Subtree path on which commit cohort operates.
     * @param cohort Commit cohort
     * @return Registaration object for DOM Data Three Commit cohort.
     */
    <D extends DataObject, T extends DataTreeCommitCohort<D>> ObjectRegistration<T> registerCommitCohort(
            DataTreeIdentifier<D> subtree, T cohort);

}