package com.onaro.util.jfc.wizard;

import com.onaro.util.jfc.*;


/**
 * A model of a multi step data entry wizard.
 */
public interface WizardModel {

    /**
     * Gets the title of this wizard. The actual title is a concatenation of
     * the wizard's title and the current step's title.
     *
     * @return this wizard's title
     */
    public String getTitle();

    /**
     * Gets the first step in the wizard.
     *
     * @return the first step
     */
    public WizardStep getFirstStep();

    /**
     * Invoked when the wizard is started to allow the model to reset itself.
     * @param wizard
     */
    public void init(Wizard wizard) throws WizardException;

    /**
     * Invoked when a wizard was canceled to allow the model to release resources.
     */
    public void cancel();

    /**
     * Invoked when a wizard is finished and the data should be comitted.
     */
    public void finish();

    /**
     * Tests if the model was modified since it was initialized. Used to determine
     * if "cancle" should be confirmed by the user.
     *
     * @true if the model is modified
     */
    public boolean isModified();
}