opendaylight/sal/yang-prototype/yang/yang-model-api/src/main/java/org/opendaylight/controller/yang/model/api/SchemaNode.java

   1 /*\r
   2  * Copyright (c) 2013 Cisco Systems, Inc. and others.  All rights reserved.\r
   3  *\r
   4  * This program and the accompanying materials are made available under the\r
   5  * terms of the Eclipse Public License v1.0 which accompanies this distribution,\r
   6  * and is available at http://www.eclipse.org/legal/epl-v10.html\r
   7  */\r
   8 package org.opendaylight.controller.yang.model.api;\r
   9 \r
  10 import java.util.List;\r
  11 \r
  12 import org.opendaylight.controller.yang.common.QName;\r
  13 \r
  14 /**\r
  15  * SchemaNode represents a node in schema tree.\r
  16  */\r
  17 public interface SchemaNode {\r
  18 \r
  19     public QName getQName();\r
  20 \r
  21     public SchemaPath getPath();\r
  22 \r
  23     /**\r
  24      * @return textual description of this node.\r
  25      */\r
  26     public String getDescription();\r
  27 \r
  28     /**\r
  29      * @return textual cross-reference to an external document that provides\r
  30      *         additional information relevant to this node.\r
  31      */\r
  32     public String getReference();\r
  33 \r
  34     /**\r
  35      * @return actual status of this node.\r
  36      */\r
  37     public Status getStatus();\r
  38 \r
  39     /**\r
  40      * @return collection of all unknown nodes defined under this schema node.\r
  41      */\r
  42     public List<UnknownSchemaNode> getUnknownSchemaNodes();\r
  43 \r
  44 }\r