yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/ConstraintMetaDefinition.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 /**
  11  * Contains methods which retrieve values for description, error message, error
  12  * app tag and reference (to other document).
  13  *
  14  */
  15 public interface ConstraintMetaDefinition {
  16
  17     /**
  18      * Returns the value of the argument of YANG <code>description</code>
  19      * keyword.
  20      *
  21      * @return string with the description
  22      */
  23     String getDescription();
  24
  25     /**
  26      * Returns the value of the argument of YANG <code>error-app-tag</code>
  27      * keyword.
  28      *
  29      * @return string with the application tag
  30      */
  31     String getErrorAppTag();
  32
  33     /**
  34      * Returns the value of the argument of YANG <code>error-message</code>
  35      * keyword.
  36      *
  37      * @return string with the error message
  38      */
  39     String getErrorMessage();
  40
  41     /**
  42      * Returns the value of the argument of YANG <code>reference</code> keyword.
  43      *
  44      * @return string with reference to some other document
  45      */
  46     String getReference();
  47 }