Package de.xima.fc.prompt.service.support

Class PromptTextParameter

java.lang.Object

de.xima.fc.prompt.service.support.PromptTextParameter

All Implemented Interfaces:

Serializable

public class PromptTextParameter
extends Object
implements Serializable

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
PromptTextParameter()

Method Summary

Modifier and Type	Method	Description
String	getDescription()	Gets the localized description of this input parameter.
String	getLabel()	Gets the localized description of this input parameter.
String	getName()	Gets the technical name of this input parameter.
boolean	isRequired()	Gets whether this input parameter is required.
void	setDescription(String description)	Sets the localized description of this input parameter.
void	setLabel(String label)	Sets the localized description of this input parameter.
void	setName(String name)	Sets the technical name of this input parameter.
void	setRequired(boolean required)	Sets whether this input parameter is required.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

PromptTextParameter

public PromptTextParameter()

Method Detail

getDescription

public String getDescription()

Gets the localized description of this input parameter. Can be empty when not description is available.

Returns:

The localized description of this input parameter.

setDescription

public void setDescription(String description)

Sets the localized description of this input parameter. Can be empty when no description is available.

Parameters:

description - The localized description of this input parameter.

getLabel

public String getLabel()

Gets the localized description of this input parameter. Can be empty when not description is available.

Returns:

The localized description of this input parameter.

setLabel

public void setLabel(String label)

Sets the localized description of this input parameter. Can be empty when no description is available.

Parameters:

label - The localized description of this input parameter.

getName

public String getName()

Gets the technical name of this input parameter. This is used to identify the input parameter in the prompt.

Returns:

The name of this input parameter.

setName

public void setName(String name)

Sets the technical name of this input parameter. This is used to identify the input parameter in the prompt.

Parameters:

name - The name of this input parameter.

isRequired

public boolean isRequired()

Gets whether this input parameter is required. If true, the user must provide a value for this input parameter.

Returns:

True if this input parameter is required, false otherwise.

setRequired

public void setRequired(boolean required)

Sets whether this input parameter is required. If true, the user must provide a value for this input parameter.

Parameters:

required - True if this input parameter is required, false otherwise.

toString

public String toString()

Overrides:

toString in class Object