opendaylight/sal/yang-prototype/yang/yang-model-api/src/main/java/org/opendaylight/controller/yang/model/api/ListSchemaNode.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  * Interface describing YANG 'list' statement.\r
  16  * <p>\r
  17  * The 'list' statement is used to define an interior data node in the schema\r
  18  * tree. A list entry is uniquely identified by the values of the list's keys,\r
  19  * if defined.\r
  20  * </p>\r
  21  */\r
  22 public interface ListSchemaNode extends DataNodeContainer, AugmentationTarget,\r
  23         DataSchemaNode {\r
  24 \r
  25     /**\r
  26      * @return List of QNames of leaf identifiers of this list\r
  27      */\r
  28     public List<QName> getKeyDefinition();\r
  29 \r
  30     /**\r
  31      * YANG 'ordered-by' statement. It defines whether the order of entries\r
  32      * within a list are determined by the user or the system. If not present,\r
  33      * default is false.\r
  34      *\r
  35      * @return true if ordered-by argument is "user", false otherwise\r
  36      */\r
  37     boolean isUserOrdered();\r
  38 \r
  39 }\r