public interface UserInteraction
| Modifier and Type | Interface and Description |
|---|---|
static class |
UserInteraction.MessageType
Type of message displayed to the user.
|
| 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.
|
Object confirm(LocalizableMessage summary, LocalizableMessage detail, LocalizableMessage title, UserInteraction.MessageType type, LocalizableMessage[] options, LocalizableMessage def)
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 dialogdetail - more details of the messagetitle - of the prompt if anytype - of messageoptions - set of options to give the userdef - the default option from optionsoptions parameter.Object confirm(LocalizableMessage summary, LocalizableMessage detail, LocalizableMessage fineDetails, LocalizableMessage title, UserInteraction.MessageType type, LocalizableMessage[] options, LocalizableMessage def, LocalizableMessage viewDetailsOption)
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 dialogdetail - more details of the messagefineDetails - 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 texttitle - of the prompt if anytype - of messageoptions - set of options to give the userdef - the default option from optionsviewDetailsOption - name of the option to be used for showing the
details. If null a default will be used.options parameter.String createUnorderedList(List<?> list)
list - to formatboolean isCLI()
true if the user interaction is command-line based and
false otherwise.boolean isForceOnError()
boolean isInteractive()
true if the CLI user has requested interactive
behavior.Copyright © 2010-2015 ForgeRock AS. All Rights Reserved.