IMessage.java

package com.digiarea.closure.model.validation;

import javafx.scene.control.Control;

/**
 * This interface encapsulates a single message that can be shown in a form.
 * Messages can be associated with controls, or be of a general nature.
 * 
 * @see IMessageManager
 * @since 3.3
 */
public interface IMessage extends IMessageProvider {

    String getCategory();

    /**
     * Returns the unique message key
     * 
     * @return the unique message key
     */
    Object getKey();

    /**
     * Returns data for application use
     * 
     * @return data object
     */
    Object getData();

    /**
     * Returns the control this message is associated with.
     * 
     * @return the control or <code>null</code> if this is a general message.
     */
    Control getControl();

    void setControl(Control control);

    /**
     * Messages that are associated with controls can be shown with a prefix
     * that indicates the origin of the message (e.g. the label preceeding the
     * control).
     * 
     * @return the message prefix or <code>null</code> if this is a general
     *         message
     */
    String getPrefix();

}