yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/AugmentationSchema.java

   1 /*
   2  * Copyright (c) 2013 Cisco Systems, Inc. and others.  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.yangtools.yang.model.api;
   9
  10 import java.util.List;
  11
  12 /**
  13  * AugmentationSchema represents augment definition. The "augment" statement
  14  * allows a module or submodule to add to the schema tree defined in an external
  15  * module, or the current module and its submodules, and to add to the nodes
  16  * from a grouping in a "uses" statement.
  17  */
  18 public interface AugmentationSchema extends DataNodeContainer {
  19
  20     /**
  21      * @return when statement
  22      */
  23     RevisionAwareXPath getWhenCondition();
  24
  25     /**
  26      * @return textual description of this augment.
  27      */
  28     String getDescription();
  29
  30     /**
  31      * @return textual cross-reference to an external document that provides
  32      *         additional information relevant to this node.
  33      */
  34     String getReference();
  35
  36     /**
  37      * @return actual status of this node.
  38      */
  39     Status getStatus();
  40
  41     /**
  42      * @return SchemaPath that identifies a node in the schema tree. This node
  43      *         is called the augment's target node. The target node MUST be
  44      *         either a container, list, choice, case, input, output, or
  45      *         notification node. It is augmented with the nodes defined as
  46      *         child nodes of this AugmentationSchema.
  47      */
  48     SchemaPath getTargetPath();
  49
  50     /**
  51      * @return collection of all unknown nodes defined in this augmentation
  52      */
  53     List<UnknownSchemaNode> getUnknownSchemaNodes();
  54
  55 }