/*
 * JBoss, Home of Professional Open Source
 * Copyright 2013, Red Hat, Inc. and individual contributors
 * by the @authors tag. See the copyright.txt in the distribution for a
 * full listing of individual contributors.
 *
 * This is free software; you can redistribute it and/or modify it
 * under the terms of the GNU Lesser General Public License as
 * published by the Free Software Foundation; either version 2.1 of
 * the License, or (at your option) any later version.
 *
 * This software is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this software; if not, write to the Free
 * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
 * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
 */
package org.richfaces.fragment.message;

import org.openqa.selenium.WebElement;
import org.richfaces.fragment.common.AdvancedInteractions;
import org.richfaces.fragment.common.WaitingWrapper;

/**
 *
 * @author <a href="mailto:jstefek@redhat.com">Jiri Stefek</a>
 */
public interface Message extends AdvancedInteractions<Message.AdvancedMessageInteractions> {

    /**
     * Represents the severity of the messages represented by Message component.
     *
     * @author <a href="mailto:jstefek@redhat.com">Jiri Stefek</a>
     */
    public enum MessageType {

        FATAL,
        ERROR,
        INFORMATION,
        WARNING,
        OK;
    }

    /**
     * Gets the summary part of the message.
     *
     * @return the message summary
     */
    String getSummary();

    /**
     * Gets the detail part of the message.
     *
     * @return the message detail
     */
    String getDetail();

    /**
     * Gets the message severity.
     *
     * @return the message type which represents the severity
     */
    MessageType getType();

    public interface AdvancedMessageInteractions {

        boolean isVisible();

        WebElement getRootElement();

        WebElement getDetailElement();

        WebElement getSummaryElement();

        WaitingWrapper waitUntilMessageIsNotVisible();

        WaitingWrapper waitUntilMessageIsVisible();
    }
}