/*
 * Copyright (c) 2013 Cisco Systems, Inc. and others.  All rights reserved.
 *
 * This program and the accompanying materials are made available under the
 * terms of the Eclipse Public License v1.0 which accompanies this distribution,
 * and is available at http://www.eclipse.org/legal/epl-v10.html
 */
package org.opendaylight.yangtools.yang.model.api;

/**
 * Contains methods which retrieve values for description, error message, error
 * app tag and reference (to other document).
 *
 */
public interface ConstraintMetaDefinition {

    /**
     * Returns the value of the argument of YANG <code>description</code>
     * keyword.
     *
     * @return string with the description
     */
    String getDescription();

    /**
     * Returns the value of the argument of YANG <code>error-app-tag</code>
     * keyword.
     *
     * @return string with the application tag
     */
    String getErrorAppTag();

    /**
     * Returns the value of the argument of YANG <code>error-message</code>
     * keyword.
     *
     * @return string with the error message
     */
    String getErrorMessage();

    /**
     * Returns the value of the argument of YANG <code>reference</code> keyword.
     *
     * @return string with reference to some other document
     */
    String getReference();
}