Package com.sun.identity.install.tools.configurator

Class TaskInteraction

java.lang.Object

com.sun.identity.install.tools.configurator.BaseInteraction

com.sun.identity.install.tools.configurator.UserResponseInteraction

com.sun.identity.install.tools.configurator.TaskInteraction

public class TaskInteraction
extends UserResponseInteraction

Constructor Summary

Constructors

Constructor	Description
TaskInteraction()

Method Summary

Modifier and Type	Method	Description
ArrayList	getDisplayMessages()	Method that needs to be implemented by the sub-classes to return the Localized Messages that need to be displayed as part of the interaction.
LocalizedMessage	getDisplayMessagesHeader()
LocalizedMessage	getPromptMessage(IStateAccess state)	Method that needs to be implemented by the sub-classes to return the prompt message that needs to be displayed for the user to input data.
Map	getResultStatusMap()	Method that needs to be implemented by the sub-classes to intialize the result status Map.
BaseOptions	getUserOptions(IStateAccess state)	Method that needs to be implemented by the sub-classes to return the ResponseOption's and return the appropriate BaseOptions. * viz., SingleLineOptions & MutliLineOptions.
LocalizedMessage	getUserOptionsHeader()
void	setResultStatusMap()

Methods inherited from class com.sun.identity.install.tools.configurator.UserResponseInteraction

confirmOnExitStatus, displayMessages, getPromptValue, interact

Methods inherited from class com.sun.identity.install.tools.configurator.BaseInteraction

displayOptionsHelp, displayPromptMessage

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

TaskInteraction

public TaskInteraction()

Method Detail

getDisplayMessagesHeader

public LocalizedMessage getDisplayMessagesHeader()

getDisplayMessages

public ArrayList getDisplayMessages()

Description copied from class: BaseInteraction

Method that needs to be implemented by the sub-classes to return the Localized Messages that need to be displayed as part of the interaction.

Specified by:

getDisplayMessages in class BaseInteraction

Returns:

ArrayList of LocalizedMessage objects or empty or null ArrayList

getPromptMessage

public LocalizedMessage getPromptMessage(IStateAccess state)

Description copied from class: BaseInteraction

Method that needs to be implemented by the sub-classes to return the prompt message that needs to be displayed for the user to input data.

Specified by:

getPromptMessage in class BaseInteraction

Parameters:

state - IStateAccess

Returns:

a LocalizedMessage Prompt

getUserOptionsHeader

public LocalizedMessage getUserOptionsHeader()

getUserOptions

public BaseOptions getUserOptions(IStateAccess state)
                           throws InstallException

Description copied from class: BaseInteraction

Method that needs to be implemented by the sub-classes to return the ResponseOption's and return the appropriate BaseOptions. * viz., SingleLineOptions & MutliLineOptions.

Specified by:

getUserOptions in class BaseInteraction

Parameters:

state - IStateAccess

Returns:

a BaseOptions with ResponseOption's populated.

Throws:

InstallException - if an error occurred while getting the user options

getResultStatusMap

public Map getResultStatusMap()

Description copied from class: UserResponseInteraction

Method that needs to be implemented by the sub-classes to intialize the result status Map. The map should be constructed with key = display item of a UserOption with value of InteractionResultStatus object that corresponds to that UserOption.

Specified by:

getResultStatusMap in class UserResponseInteraction

Returns:

a Map constructed with .

setResultStatusMap

public void setResultStatusMap()