org.opends.quicksetup

Interface UserInteraction

All Known Implementing Classes:

CliUserInteraction

public interface UserInteraction

This class describes methods for supporting interaction with the user.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	UserInteraction.MessageType Type of message displayed to the user.

Method Summary

Methods

Modifier and Type	Method and Description
Object	confirm(LocalizableMessage summary, LocalizableMessage detail, LocalizableMessage fineDetails, LocalizableMessage title, UserInteraction.MessageType type, LocalizableMessage[] options, LocalizableMessage def, LocalizableMessage viewDetailsOption) Present a list of choices to the user and wait for them to select one of them.
Object	confirm(LocalizableMessage summary, LocalizableMessage detail, LocalizableMessage title, UserInteraction.MessageType type, LocalizableMessage[] options, LocalizableMessage def) Present a list of choices to the user and wait for them to select one of them.
String	createUnorderedList(List<?> list) Creates a list appropriate for the presentation implementation.
boolean	isCLI() Tells whether the interaction is command-line based.
boolean	isForceOnError() Indicates whether or not the CLI based user has requested to continue when a non critical error occurs.
boolean	isInteractive() Indicates whether or not the CLI user has requested interactive behavior.

Method Detail

confirm

Object confirm(LocalizableMessage summary,
             LocalizableMessage detail,
             LocalizableMessage title,
             UserInteraction.MessageType type,
             LocalizableMessage[] options,
             LocalizableMessage def)

Present a list of choices to the user and wait for them to select one of them.

Parameters:

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

detail - more details of the message

title - of the prompt if any

type - of message

options - set of options to give the user

def - the default option from options

Returns:

Object that is the same value as the user selection from the options parameter.

confirm

Object confirm(LocalizableMessage summary,
             LocalizableMessage detail,
             LocalizableMessage fineDetails,
             LocalizableMessage title,
             UserInteraction.MessageType type,
             LocalizableMessage[] options,
             LocalizableMessage def,
             LocalizableMessage viewDetailsOption)

Present a list of choices to the user and wait for them to select one of them.

Parameters:

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

detail - more details of the message

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

title - of the prompt if any

type - of message

options - set of options to give the user

def - the default option from options

viewDetailsOption - name of the option to be used for showing the details. If null a default will be used.

Returns:

Object that is the same value as the user selection from the options parameter.

createUnorderedList

String createUnorderedList(List<?> list)

Creates a list appropriate for the presentation implementation.

Parameters:

list - to format

Returns:

String representing the list

isCLI

boolean isCLI()

Tells whether the interaction is command-line based.

Returns:

true if the user interaction is command-line based and false otherwise.

isForceOnError

boolean isForceOnError()

Indicates whether or not the CLI based user has requested to continue when a non critical error occurs.

Returns:

boolean where true indicates to continue if there is a non critical error.

isInteractive

boolean isInteractive()

Indicates whether or not the CLI user has requested interactive behavior.

Returns:

true if the CLI user has requested interactive behavior.