org.andromda.andromdapp

Class Prompt

java.lang.Object

org.andromda.andromdapp.Prompt

public class Prompt
extends Object

Represents a user prompt used by AndroMDApp.

Author:

Chad Brandon

Constructor Summary

Constructors

Constructor and Description
Prompt()

Method Summary

Methods

Modifier and Type	Method and Description
void	addCondition(Condition condition) Adds a condition to this prompt.
void	addPreconditions(Conditions preconditions) Adds preconditions to this prompt.
void	addResponse(String response) Adds a response to the possible responses.
List<Condition>	getConditions() Gets the conditions defined in this prompt.
String	getId() Gets the unique id of this prompt.
List<Conditions>	getPreconditions() Gets the preconditions for this prompt.
Object	getResponse(Object response) Gets the response object converted to the appropriate type or just as it is (if no conversion took place or conversion failed).
String	getText() Gets the text of the prompt.
boolean	isRequired() Indicates whether or not this prompt is required.
boolean	isSetResponseAsTrue() Whether or not the response should be set to a boolean value of true.
boolean	isValidResponse(String response) Indicates whether or not the given response is valid according to the valid responses contained in this prompt instance.
void	setId(String id) Sets the unique id of this prompt.
void	setRequired(boolean required) Sets whether or not this prompt is required, by default the prompt is required.
void	setResponseType(String responseType) Sets the response type to use (i.e the fully qualified name of the type to which it should be converted when placed into the the template context).
void	setSetResponseAsTrue(boolean setResponseAsBoolean) Sets whether or not the response should be set to a boolean value of true.
void	setText(String text) Sets the prompt text.

Methods inherited from class java.lang.Object

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

Constructor Detail

Prompt

public Prompt()

Method Detail

getId

public String getId()

Gets the unique id of this prompt.

Returns:

Returns the id.

setId

public void setId(String id)

Sets the unique id of this prompt.

Parameters:

id - The id to set.

setRequired

public void setRequired(boolean required)

Sets whether or not this prompt is required, by default the prompt is required.

Parameters:

required - whether or not this prompt is required

isRequired

public boolean isRequired()

Indicates whether or not this prompt is required.

Returns:

true/false

getText

public String getText()

Gets the text of the prompt.

Returns:

Returns the text.

setText

public void setText(String text)

Sets the prompt text.

Parameters:

text - The text to set.

addResponse

public void addResponse(String response)

Adds a response to the possible responses.

Parameters:

response - the response to add.

isValidResponse

public boolean isValidResponse(String response)

Indicates whether or not the given response is valid according to the valid responses contained in this prompt instance.

Parameters:

response - the response to check.

Returns:

true/false

getResponse

public Object getResponse(Object response)

Gets the response object converted to the appropriate type or just as it is (if no conversion took place or conversion failed).

Parameters:

response - the response to convert.

Returns:

the response as an object.

setResponseType

public void setResponseType(String responseType)

Sets the response type to use (i.e the fully qualified name of the type to which it should be converted when placed into the the template context).

Parameters:

responseType - the fully qualified response type name.

addCondition

public void addCondition(Condition condition)

Adds a condition to this prompt.

Parameters:

condition - the condition which must apply to this prompt.

getConditions

public List<Condition> getConditions()

Gets the conditions defined in this prompt.

Returns:

the conditions that are defined within this prompt.

addPreconditions

public void addPreconditions(Conditions preconditions)

Adds preconditions to this prompt.

Parameters:

preconditions - the preconditions to add.

getPreconditions

public List<Conditions> getPreconditions()

Gets the preconditions for this prompt.

Returns:

the prompt preconditions.

isSetResponseAsTrue

public boolean isSetResponseAsTrue()

Whether or not the response should be set to a boolean value of true.

Returns:

Returns the setResponseAsTrue.

setSetResponseAsTrue

public void setSetResponseAsTrue(boolean setResponseAsBoolean)

Sets whether or not the response should be set to a boolean value of true.

Parameters:

setResponseAsBoolean - The setResponseAsTrue to set.