001/*
002 * The contents of this file are subject to the terms of the Common Development and
003 * Distribution License (the License). You may not use this file except in compliance with the
004 * License.
005 *
006 * You can obtain a copy of the License at legal/CDDLv1.0.txt. See the License for the
007 * specific language governing permission and limitations under the License.
008 *
009 * When distributing Covered Software, include this CDDL Header Notice in each file and include
010 * the License file at legal/CDDLv1.0.txt. If applicable, add the following below the CDDL
011 * Header, with the fields enclosed by brackets [] replaced by your own identifying
012 * information: "Portions Copyright [year] [name of copyright owner]".
013 *
014 * Copyright 2008 Sun Microsystems, Inc.
015 * Portions Copyright 2014 ForgeRock AS.
016 */
017
018package org.opends.quicksetup;
019
020import org.forgerock.i18n.LocalizableMessage;
021
022/**
023 * Step in a QuickSetup wizard application.
024 */
025public interface WizardStep {
026
027  /**
028   * Gets the message key associated with the display name of this step.
029   * @return String message key for accessing this step's display name
030   * in a message bundle
031   */
032  LocalizableMessage getDisplayMessage();
033
034  /**
035   * Indicates that when this step is displayed the application will
036   * be asked to launch itself.
037   * @return true indicating that this is the progress step for the
038   * application
039   */
040  boolean isProgressStep();
041
042  /**
043   * Indicates whether this is the finished step for the application or not.
044   * @return <CODE>true</CODE> if this is the finished step for the application
045   * and <CODE>false</CODE> otherwise.
046   */
047  boolean isFinishedStep();
048
049  /**
050   * Indicates whether this is the license approval step.
051   * @return <CODE>true</CODE> if this is the license approval step
052   * and <CODE>false</CODE> otherwise.
053   */
054  boolean isLicenseStep();
055
056}