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

   1 /*
   2  * Copyright (c) 2014 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 /**
  11  *
  12  * Node which can have documentation assigned.
  13  *
  14  */
  15 public interface DocumentedNode {
  16
  17     /**
  18      * Returns description of the instance of the type <code>SchemaNode</code>
  19      *
  20      * @return string with textual description the node which represents the
  21      *         argument of the YANG <code>description</code> substatement
  22      */
  23     String getDescription();
  24
  25     /**
  26      * Returns reference of the instance of the type <code>SchemaNode</code>
  27      *
  28      * The reference refers to external document that provides additional
  29      * information relevant for the instance of this type.
  30      *
  31      * @return string with the reference to some external document which
  32      *         represents the argument of the YANG <code>reference</code>
  33      *         substatement
  34      */
  35     String getReference();
  36
  37     /**
  38      * Returns status of the instance of the type <code>SchemaNode</code>
  39      *
  40      * @return status of this node which represents the argument of the YANG
  41      *         <code>status</code> substatement
  42      */
  43     Status getStatus();
  44 }