/*
 * Copyright © Red Gate Software Ltd 2010-2020
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *         http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.flywaydb.core.api.callback;

A warning that occurred while executing a statement.
Flyway Teams only
/**
 * A warning that occurred while executing a statement.
 * <p><i>Flyway Teams only</i></p>
 */
public interface Warning {
    
Returns:
The warning code./**
     * @return The warning code.
     */
    int getCode();

    
Returns:
The warning state./**
     * @return The warning state.
     */
    String getState();

    
Returns:
The warning message./**
     * @return The warning message.
     */
    String getMessage();

    
Checks whether this warning has already been handled.
Returns:
true true if this warning has already be handled or false if it should flow via the default warning handler./**
     * Checks whether this warning has already been handled.
     *
     * @return {@code true} {@code true} if this warning has already be handled or {@code false} if it should flow
     * via the default warning handler.
     */
    boolean isHandled();

    
Sets whether this warning has already been handled.
Params:
handled – true if this warning has already be handled or false if it should flow via the default warning handler./**
     * Sets whether this warning has already been handled.
     *
     * @param handled {@code true} if this warning has already be handled or {@code false} if it should flow via the
     *                default warning handler.
     */
    void setHandled(boolean handled);
}