plugins/netconf-dom-api/src/main/java/org/opendaylight/netconf/dom/api/tx/NetconfDOMDataBrokerFieldsExtension.java

   1 /*
   2  * Copyright © 2020 FRINX s.r.o. All rights reserved.
   3  *
   4  * This program and the accompanying materials are made available under the
   5  * terms of the Eclipse Public License v1.0 which accompanies this distribution,
   6  * and is available at http://www.eclipse.org/legal/epl-v10.html
   7  */
   8 package org.opendaylight.netconf.dom.api.tx;
   9
  10 import org.eclipse.jdt.annotation.NonNull;
  11 import org.opendaylight.mdsal.dom.api.DOMDataBroker.Extension;
  12
  13 /**
  14  * DOM data broker extension with an option to read only selected fields under parent data node.
  15  */
  16 public interface NetconfDOMDataBrokerFieldsExtension extends Extension {
  17     /**
  18      * Create a new read-only transaction with an option to read only selected fields from target data node.
  19      *
  20      * @return A new read-only transaction.
  21      */
  22     @NonNull NetconfDOMFieldsReadTransaction newReadOnlyTransaction();
  23
  24     /**
  25      * Create a new read-write transaction with an option to read only selected fields from target data node.
  26      *
  27      * @return A new read-write transaction.
  28      */
  29     @NonNull NetconfDOMFieldsReadWriteTransaction newReadWriteTransaction();
  30
  31     /**
  32      * Create a new transaction chain with an option to read only selected fields from target data node.
  33      *
  34      * @return A new transaction chain.
  35      */
  36     @NonNull NetconfDOMFieldsTransactionChain createTransactionChain();
  37 }