model/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 import java.util.Optional;
  11
  12 /**
  13  * Contains methods which retrieve values for description, error message, error app tag and reference (to some external
  14  * definition, resource or similar).
  15  */
  16 public interface ConstraintMetaDefinition extends DocumentedNode {
  17
  18     /**
  19      * Returns the value of the argument of YANG <code>error-app-tag</code> keyword.
  20      *
  21      * @return string with the application tag, or empty if it was not provided.
  22      */
  23     Optional<String> getErrorAppTag();
  24
  25     /**
  26      * Returns the value of the argument of YANG <code>error-message</code> keyword.
  27      *
  28      * @return string with the error message, or empty if it was not provided.
  29      */
  30     Optional<String> getErrorMessage();
  31 }