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