/*
|
* CDDL HEADER START
|
*
|
* The contents of this file are subject to the terms of the
|
* Common Development and Distribution License, Version 1.0 only
|
* (the "License"). You may not use this file except in compliance
|
* with the License.
|
*
|
* You can obtain a copy of the license at legal-notices/CDDLv1_0.txt
|
* or http://forgerock.org/license/CDDLv1.0.html.
|
* See the License for the specific language governing permissions
|
* and limitations under the License.
|
*
|
* When distributing Covered Code, include this CDDL HEADER in each
|
* file and include the License file at legal-notices/CDDLv1_0.txt.
|
* If applicable, add the following below this CDDL HEADER, with the
|
* fields enclosed by brackets "[]" replaced with your own identifying
|
* information:
|
* Portions Copyright [yyyy] [name of copyright owner]
|
*
|
* CDDL HEADER END
|
*
|
*
|
* Copyright 2008-2010 Sun Microsystems, Inc.
|
* Portions copyright 2012 ForgeRock AS.
|
*/
|
|
package org.opends.quicksetup;
|
import org.opends.messages.Message;
|
|
import java.util.List;
|
|
/**
|
* This class describes methods for supporting interaction with the user.
|
*/
|
public interface UserInteraction {
|
|
/**
|
* Type of message displayed to the user. The type of message
|
* may affect the presentation of the interaction.
|
*/
|
public enum MessageType {
|
|
/** A message with no context. */
|
PLAIN,
|
|
/** A message displayed as a result of an error. */
|
ERROR,
|
|
/** A message displayed informing the user of something. */
|
INFORMATION,
|
|
/** A message displayed to warn the user. */
|
WARNING,
|
|
/** A message displayed to ask the user a question. */
|
QUESTION
|
}
|
|
/**
|
* Present a list of choices to the user and wait for them to select one
|
* of them.
|
* @param summary text to present to the user. This is usually just a
|
* string bug For GUI applications can be a component that will appear
|
* inside a dialog
|
* @param detail more details of the message
|
* @param title of the prompt if any
|
* @param type of message
|
* @param options set of options to give the user
|
* @param def the default option from <code>options</code>
|
* @return Object that is the same value as the user selection from the
|
* <code>options</code> parameter.
|
*/
|
Object confirm(Message summary, Message detail,
|
Message title, MessageType type,
|
Message[] options, Message def);
|
|
/**
|
* Present a list of choices to the user and wait for them to select one
|
* of them.
|
* @param summary text to present to the user. This is usually just a
|
* string bug For GUI applications can be a component that will appear
|
* inside a dialog
|
* @param detail more details of the message
|
* @param fineDetails even finer details. This text may be rendered in
|
* such a way that the user needs to take some sort of action to
|
* see this text
|
* @param title of the prompt if any
|
* @param type of message
|
* @param options set of options to give the user
|
* @param def the default option from <code>options</code>
|
* @param viewDetailsOption name of the option to be used for showing the
|
* details. If null a default will be used.
|
* @return Object that is the same value as the user selection from the
|
* <code>options</code> parameter.
|
*/
|
Object confirm(Message summary, Message detail, Message fineDetails,
|
Message title, MessageType type, Message[] options,
|
Message def, Message viewDetailsOption);
|
|
/**
|
* Creates a list appropriate for the presentation implementation.
|
*
|
* @param list to format
|
* @return String representing the list
|
*/
|
String createUnorderedList(List<?> list);
|
|
/**
|
* Tells whether the interaction is command-line based.
|
* @return <CODE>true</CODE> if the user interaction is command-line based and
|
* <CODE>false</CODE> otherwise.
|
*/
|
boolean isCLI();
|
|
/**
|
* Indicates whether or not the CLI based user has requested to continue when
|
* a non critical error occurs.
|
*
|
* @return boolean where true indicates to continue if there is a non critical
|
* error.
|
*/
|
boolean isForceOnError();
|
|
/**
|
* Indicates whether or not the CLI user has requested interactive behavior.
|
*
|
* @return <code>true</code> if the CLI user has requested interactive
|
* behavior.
|
*/
|
boolean isInteractive();
|
|
}
|
