Refactor TypedSchemaNode
[yangtools.git] / yang / yang-model-api / src / main / java / org / opendaylight / yangtools / yang / model / api / ListSchemaNode.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.Collection;
11 import java.util.List;
12 import javax.annotation.Nonnull;
13 import org.opendaylight.yangtools.yang.common.QName;
14
15 /**
16  * Interface describing YANG 'list' statement.
17  *
18  * <p>
19  * The 'list' statement is used to define an interior data node in the schema tree. A list entry is uniquely identified
20  * by the values of the list's keys, if defined.
21  */
22 public interface ListSchemaNode extends DataNodeContainer, AugmentationTarget, DataSchemaNode,
23         NotificationNodeContainer, ActionNodeContainer, MustConstraintAware {
24     /**
25      * Returns the list of leaf identifiers.
26      *
27      * @return List of QNames of leaf identifiers of this list
28      */
29     List<QName> getKeyDefinition();
30
31     /**
32      * YANG 'ordered-by' statement. It defines whether the order of entries
33      * within a list are determined by the user or the system. If not present,
34      * default is false.
35      *
36      * @return true if ordered-by argument is "user", false otherwise
37      */
38     boolean isUserOrdered();
39
40     /**
41      * Returns unique constraints.
42      *
43      * @return Collection of unique constraints of this list schema node
44      */
45     @Nonnull
46     Collection<UniqueConstraint> getUniqueConstraints();
47 }