com.sas.prompts.definitions
Interface PromptDefinitionInterface

All Superinterfaces:

java.lang.Cloneable, com.sas.prompts.IdentifiablePromptInterface, com.sas.util.macrovar.MacroVariableOptionInterface, com.sas.util.xmlpersist.PersistenceInterface, com.sas.PublicClonable, com.sas.util.ResourceReferencesInterface, com.sas.models.VersionInterface

All Known Subinterfaces:

com.sas.prompts.definitions.MutablePromptDefinitionInterface, MutableSelectableDefinitionInterface, SelectableDefinitionInterface

All Known Implementing Classes:

BaseDefinitionRange, BaseFileDefinition, ColorDefinition, DataSourceColumnDefinition, DataSourceDefinition, DateDefinition, DateRangeDefinition, DoubleDefinition, DoubleRangeDefinition, InputFileDefinition, IntegerDefinition, IntegerRangeDefinition, ModalGroupDefinition, OutputFileDefinition, PromptDefinition, SASLibraryDefinition, StringRangeDefinition, TextDefinition

public interface PromptDefinitionInterface
extends com.sas.prompts.IdentifiablePromptInterface, com.sas.models.VersionInterface, com.sas.util.xmlpersist.PersistenceInterface, com.sas.PublicClonable, com.sas.util.ResourceReferencesInterface, com.sas.util.macrovar.MacroVariableOptionInterface

Interface used by all classes which define types of prompts. It defines the basic information that all prompts surface. All the methods are "get" methods as the "set" methods are defined on the individual prompt implementations.

Field Summary

static long	PROMPT_VALIDATION_ERROR_ABOVE_MAXIMUM Error code possibly returned from getPromptValueValidationErrors.
static long	PROMPT_VALIDATION_ERROR_ABOVE_MAXIMUM_DECIMAL_PLACES Error code possibly returned from getPromptValueValidationErrors.
static long	PROMPT_VALIDATION_ERROR_ABOVE_MAXIMUM_LENGTH Error code possibly returned from getPromptValueValidationErrors.
static long	PROMPT_VALIDATION_ERROR_ABOVE_MAXIMUM_LINES Error code possibly returned from getPromptValueValidationErrors.
static long	PROMPT_VALIDATION_ERROR_ABOVE_MAXIMUM_VALUE_COUNT Error code possibly returned from getPromptValueValidationErrors.
static long	PROMPT_VALIDATION_ERROR_BELOW_MINIMUM Error code possibly returned from getPromptValueValidationErrors.
static long	PROMPT_VALIDATION_ERROR_BELOW_MINIMUM_LENGTH Error code possibly returned from getPromptValueValidationErrors.
static long	PROMPT_VALIDATION_ERROR_BELOW_MINIMUM_VALUE_COUNT Error code possibly returned from getPromptValueValidationErrors.
static long	PROMPT_VALIDATION_ERROR_DATA_SOURCE_COLUMN_TYPE_NOT_ALLOWED Error code possibly returned from getPromptValueValidationErrors.
static long	PROMPT_VALIDATION_ERROR_DATA_SOURCE_CONTAINS_NO_DATA_ITEMS Error code possibly returned from getPromptValueValidationErrors.
static long	PROMPT_VALIDATION_ERROR_DATA_SOURCE_NOT_AVAILABLE Error code possibly returned from getPromptValueValidationErrors.
static long	PROMPT_VALIDATION_ERROR_DATA_SOURCE_TYPE_NOT_ALLOWED Error code possibly returned from getPromptValueValidationErrors.
static long	PROMPT_VALIDATION_ERROR_EMPTY_STATIC_LIST_AND_REQUIRED_WITH_NO_ADDITIONAL_VALUES_ALLOWED Error code possibly returned from getPromptValueValidationErrors.
static long	PROMPT_VALIDATION_ERROR_ERROR_LOADING_SHARED_PROMPT Error code possibly returned from getPromptValueValidationErrors.
static long	PROMPT_VALIDATION_ERROR_FILE_TYPE_NOT_ALLOWED Error code possibly returned from getPromptValueValidationErrors.
static long	PROMPT_VALIDATION_ERROR_FROM_SCRIPT Error code possibly returned from getPromptValueValidationErrors.
static long	PROMPT_VALIDATION_ERROR_INCORRECT_RELATIVE_DATE_VALUE Error code possibly returned from getPromptValueValidationErrors.
static long	PROMPT_VALIDATION_ERROR_INPUT_DOES_NOT_MATCH_PATTERN Error code possibly returned from getPromptValueValidationErrors.
static long	PROMPT_VALIDATION_ERROR_INVALID_INPUT_PATTERN Error code possibly returned from getPromptValueValidationErrors.
static long	PROMPT_VALIDATION_ERROR_LOWER_RANGE_VALUE_ABOVE_MAXIMUM Error code possibly returned from getPromptValueValidationErrors.
static long	PROMPT_VALIDATION_ERROR_LOWER_RANGE_VALUE_ABOVE_MAXIMUM_LENGTH Error code possibly returned from getPromptValueValidationErrors.
static long	PROMPT_VALIDATION_ERROR_LOWER_RANGE_VALUE_ABOVE_UPPER_RANGE_VALUE Error code possibly returned from getPromptValueValidationErrors.
static long	PROMPT_VALIDATION_ERROR_LOWER_RANGE_VALUE_BELOW_MINIMUM Error code possibly returned from getPromptValueValidationErrors.
static long	PROMPT_VALIDATION_ERROR_LOWER_RANGE_VALUE_BELOW_MINIMUM_LENGTH Error code possibly returned from getPromptValueValidationErrors.
static long	PROMPT_VALIDATION_ERROR_MASKED_HIDDEN_REQUIRED Error code possibly returned from getPromptValueValidationErrors.
static long	PROMPT_VALIDATION_ERROR_MAX_DECIMAL_PLACES_ABOVE_MAX_PERCISION Error code possibly returned from getPromptValueValidationErrors.
static long	PROMPT_VALIDATION_ERROR_MAXIMUM_LENGTH_BELOW_ZERO Error code possibly returned from getPromptValueValidationErrors.
static long	PROMPT_VALIDATION_ERROR_MIN_DECIMAL_PLACES_ABOVE_MAX_PERCISION Error code possibly returned from getPromptValueValidationErrors.
static long	PROMPT_VALIDATION_ERROR_MINIMUM_ABOVE_MAXIMUM Error code possibly returned from getPromptValueValidationErrors.
static long	PROMPT_VALIDATION_ERROR_MINIMUM_ABOVE_MAXIMUM_DECIMAL_PLACES Error code possibly returned from getPromptValueValidationErrors.
static long	PROMPT_VALIDATION_ERROR_MINIMUM_ABOVE_MAXIMUM_LENGTH Error code possibly returned from getPromptValueValidationErrors.
static long	PROMPT_VALIDATION_ERROR_MINIMUM_ABOVE_MAXIMUM_VALUE_COUNT Error code possibly returned from getPromptValueValidationErrors.
static long	PROMPT_VALIDATION_ERROR_MINIMUM_LENGTH_ABOVE_MAXIMUM_LENGTH Error code possibly returned from getPromptValueValidationErrors.
static long	PROMPT_VALIDATION_ERROR_MINIMUM_LENGTH_BELOW_ZERO Error code possibly returned from getPromptValueValidationErrors.
static long	PROMPT_VALIDATION_ERROR_MORE_THAN_ONE_SPECIAL_VALUE_SPECIFIED Error code possibly returned from getPromptValueValidationErrors.
static long	PROMPT_VALIDATION_ERROR_MULTIPLE_DATA_SOURCES_NOT_ALLOWED Error code possibly returned from getPromptValueValidationErrors.
static long	PROMPT_VALIDATION_ERROR_NO_DATA_SOURCE Error code possibly returned from getPromptValueValidationErrors.
static long	PROMPT_VALIDATION_ERROR_NON_EDITABLE_REQUIRED_WITH_NO_DEFAULT_NOT_ALLOWED Error code possibly returned from getPromptValueValidationErrors.
static long	PROMPT_VALIDATION_ERROR_NOT_VALID_OBJECT Error code possibly returned from getPromptValueValidationErrors.
static long	PROMPT_VALIDATION_ERROR_ONLY_DIRECTORIES_ALLOWED Error code possibly returned from getPromptValueValidationErrors.
static long	PROMPT_VALIDATION_ERROR_ONLY_FILES_ALLOWED Error code possibly returned from getPromptValueValidationErrors.
static long	PROMPT_VALIDATION_ERROR_PERIOD_ENDS_200_YEARS_AHEAD Error code possibly returned from getPromptValueValidationErrors.
static long	PROMPT_VALIDATION_ERROR_PERIOD_STARTS_200_YEARS_AGO Error code possibly returned from getPromptValueValidationErrors.
static long	PROMPT_VALIDATION_ERROR_SPECIAL_VALUE_MIXED_WITH_OTHER_VALUES Error code possibly returned from getPromptValueValidationErrors.
static long	PROMPT_VALIDATION_ERROR_STATIC_VALUE_INVALID Error code possibly returned from getPromptValueValidationErrors.
static long	PROMPT_VALIDATION_ERROR_UPPER_RANGE_VALUE_ABOVE_MAXIMUM Error code possibly returned from getPromptValueValidationErrors.
static long	PROMPT_VALIDATION_ERROR_UPPER_RANGE_VALUE_ABOVE_MAXIMUM_LENGTH Error code possibly returned from getPromptValueValidationErrors.
static long	PROMPT_VALIDATION_ERROR_UPPER_RANGE_VALUE_BELOW_MINIMUM Error code possibly returned from getPromptValueValidationErrors.
static long	PROMPT_VALIDATION_ERROR_UPPER_RANGE_VALUE_BELOW_MINIMUM_LENGTH Error code possibly returned from getPromptValueValidationErrors.
static long	PROMPT_VALIDATION_NO_ERRORS Error code possibly returned from getPromptValueValidationErrors.

Method Summary

void	clearDefaultValue() Clears the default value if one has been set.
java.lang.Object	getDefaultValue() Returns the default value for the prompt.
com.sas.datatypes.DataTypeInterface	getPromptDataType() Returns the data type that this definition uses to store/validate values set on the prompt.
java.lang.String	getPromptDescription(java.util.Locale locale) Returns the description of the prompt used when asking for the prompts value.
com.sas.util.LocalizableString	getPromptDescriptions() Returns a LocalizableString containing the descriptions for all Locales for which descriptions are set.
java.lang.String	getPromptLabel(java.util.Locale locale) Returns the label used to ask the user for the value of the prompt.
com.sas.util.LocalizableString	getPromptLabels() Returns a LocalizableString containing the labels for all Locales for which labels are set.
java.lang.String	getPromptName() Returns the name of the prompt.
java.util.Collection<ValidationEntry>	getPromptValueValidationErrors(java.lang.Object value, java.util.Locale locale) Returns a Collection containing the set of ValidationEntry objects or an empty collection if no errors were found.
com.sas.util.UserInfoInterface	getUserInfo() Returns a UserInfoInterface instance which is a String to String Map of additional information that the prompt has.
boolean	isDefaultValueSet() Returns whether the default value for the prompt has been set.
boolean	isFixed() Returns whether the prompt value can be modified.
boolean	isHidden() Returns whether the prompt should be hidden at runtime when the user is asked to provide values for prompts.
boolean	isPromptValueValid(java.lang.Object value) Deprecated.
boolean	isRequired() Returns whether the user is required to supply a value for the prompt before continuing in an application.
java.util.Collection<ValidationEntry>	validateDefinition(java.util.Locale locale) This method is used to validate that the various attributes of the definition all contain valid values.

Field Detail

PROMPT_VALIDATION_NO_ERRORS

static final long PROMPT_VALIDATION_NO_ERRORS

Error code possibly returned from getPromptValueValidationErrors.

See Also:

Constant Field Values

PROMPT_VALIDATION_ERROR_NOT_VALID_OBJECT

static final long PROMPT_VALIDATION_ERROR_NOT_VALID_OBJECT

Error code possibly returned from getPromptValueValidationErrors.

See Also:

Constant Field Values

PROMPT_VALIDATION_ERROR_BELOW_MINIMUM

static final long PROMPT_VALIDATION_ERROR_BELOW_MINIMUM

Error code possibly returned from getPromptValueValidationErrors.

See Also:

Constant Field Values

PROMPT_VALIDATION_ERROR_ABOVE_MAXIMUM

static final long PROMPT_VALIDATION_ERROR_ABOVE_MAXIMUM

Error code possibly returned from getPromptValueValidationErrors.

See Also:

Constant Field Values

PROMPT_VALIDATION_ERROR_MINIMUM_ABOVE_MAXIMUM

static final long PROMPT_VALIDATION_ERROR_MINIMUM_ABOVE_MAXIMUM

Error code possibly returned from getPromptValueValidationErrors.

See Also:

Constant Field Values

PROMPT_VALIDATION_ERROR_BELOW_MINIMUM_VALUE_COUNT

static final long PROMPT_VALIDATION_ERROR_BELOW_MINIMUM_VALUE_COUNT

Error code possibly returned from getPromptValueValidationErrors.

See Also:

Constant Field Values

PROMPT_VALIDATION_ERROR_ABOVE_MAXIMUM_VALUE_COUNT

static final long PROMPT_VALIDATION_ERROR_ABOVE_MAXIMUM_VALUE_COUNT

Error code possibly returned from getPromptValueValidationErrors.

See Also:

Constant Field Values

PROMPT_VALIDATION_ERROR_MINIMUM_ABOVE_MAXIMUM_VALUE_COUNT

static final long PROMPT_VALIDATION_ERROR_MINIMUM_ABOVE_MAXIMUM_VALUE_COUNT

Error code possibly returned from getPromptValueValidationErrors.

See Also:

Constant Field Values

PROMPT_VALIDATION_ERROR_ABOVE_MAXIMUM_LENGTH

static final long PROMPT_VALIDATION_ERROR_ABOVE_MAXIMUM_LENGTH

Error code possibly returned from getPromptValueValidationErrors.

See Also:

Constant Field Values

PROMPT_VALIDATION_ERROR_ABOVE_MAXIMUM_LINES

static final long PROMPT_VALIDATION_ERROR_ABOVE_MAXIMUM_LINES

Error code possibly returned from getPromptValueValidationErrors.

See Also:

Constant Field Values

PROMPT_VALIDATION_ERROR_BELOW_MINIMUM_LENGTH

static final long PROMPT_VALIDATION_ERROR_BELOW_MINIMUM_LENGTH

Error code possibly returned from getPromptValueValidationErrors.

See Also:

Constant Field Values

PROMPT_VALIDATION_ERROR_MINIMUM_ABOVE_MAXIMUM_LENGTH

static final long PROMPT_VALIDATION_ERROR_MINIMUM_ABOVE_MAXIMUM_LENGTH

Error code possibly returned from getPromptValueValidationErrors.

See Also:

Constant Field Values

PROMPT_VALIDATION_ERROR_LOWER_RANGE_VALUE_ABOVE_UPPER_RANGE_VALUE

static final long PROMPT_VALIDATION_ERROR_LOWER_RANGE_VALUE_ABOVE_UPPER_RANGE_VALUE

Error code possibly returned from getPromptValueValidationErrors.

See Also:

Constant Field Values

PROMPT_VALIDATION_ERROR_ABOVE_MAXIMUM_DECIMAL_PLACES

static final long PROMPT_VALIDATION_ERROR_ABOVE_MAXIMUM_DECIMAL_PLACES

Error code possibly returned from getPromptValueValidationErrors.

See Also:

Constant Field Values

PROMPT_VALIDATION_ERROR_MINIMUM_ABOVE_MAXIMUM_DECIMAL_PLACES

static final long PROMPT_VALIDATION_ERROR_MINIMUM_ABOVE_MAXIMUM_DECIMAL_PLACES

Error code possibly returned from getPromptValueValidationErrors.

See Also:

Constant Field Values

PROMPT_VALIDATION_ERROR_MINIMUM_LENGTH_BELOW_ZERO

static final long PROMPT_VALIDATION_ERROR_MINIMUM_LENGTH_BELOW_ZERO

Error code possibly returned from getPromptValueValidationErrors.

See Also:

Constant Field Values

PROMPT_VALIDATION_ERROR_MAXIMUM_LENGTH_BELOW_ZERO

static final long PROMPT_VALIDATION_ERROR_MAXIMUM_LENGTH_BELOW_ZERO

Error code possibly returned from getPromptValueValidationErrors.

See Also:

Constant Field Values

PROMPT_VALIDATION_ERROR_MINIMUM_LENGTH_ABOVE_MAXIMUM_LENGTH

static final long PROMPT_VALIDATION_ERROR_MINIMUM_LENGTH_ABOVE_MAXIMUM_LENGTH

Error code possibly returned from getPromptValueValidationErrors.

See Also:

Constant Field Values

PROMPT_VALIDATION_ERROR_NO_DATA_SOURCE

static final long PROMPT_VALIDATION_ERROR_NO_DATA_SOURCE

Error code possibly returned from getPromptValueValidationErrors.

See Also:

Constant Field Values

PROMPT_VALIDATION_ERROR_PERIOD_STARTS_200_YEARS_AGO

static final long PROMPT_VALIDATION_ERROR_PERIOD_STARTS_200_YEARS_AGO

Error code possibly returned from getPromptValueValidationErrors.

See Also:

Constant Field Values

PROMPT_VALIDATION_ERROR_PERIOD_ENDS_200_YEARS_AHEAD

static final long PROMPT_VALIDATION_ERROR_PERIOD_ENDS_200_YEARS_AHEAD

Error code possibly returned from getPromptValueValidationErrors.

See Also:

Constant Field Values

PROMPT_VALIDATION_ERROR_LOWER_RANGE_VALUE_BELOW_MINIMUM

static final long PROMPT_VALIDATION_ERROR_LOWER_RANGE_VALUE_BELOW_MINIMUM

Error code possibly returned from getPromptValueValidationErrors.

See Also:

Constant Field Values

PROMPT_VALIDATION_ERROR_LOWER_RANGE_VALUE_ABOVE_MAXIMUM

static final long PROMPT_VALIDATION_ERROR_LOWER_RANGE_VALUE_ABOVE_MAXIMUM

Error code possibly returned from getPromptValueValidationErrors.

See Also:

Constant Field Values

PROMPT_VALIDATION_ERROR_UPPER_RANGE_VALUE_BELOW_MINIMUM

static final long PROMPT_VALIDATION_ERROR_UPPER_RANGE_VALUE_BELOW_MINIMUM

Error code possibly returned from getPromptValueValidationErrors.

See Also:

Constant Field Values

PROMPT_VALIDATION_ERROR_UPPER_RANGE_VALUE_ABOVE_MAXIMUM

static final long PROMPT_VALIDATION_ERROR_UPPER_RANGE_VALUE_ABOVE_MAXIMUM

Error code possibly returned from getPromptValueValidationErrors.

See Also:

Constant Field Values

PROMPT_VALIDATION_ERROR_LOWER_RANGE_VALUE_BELOW_MINIMUM_LENGTH

static final long PROMPT_VALIDATION_ERROR_LOWER_RANGE_VALUE_BELOW_MINIMUM_LENGTH

Error code possibly returned from getPromptValueValidationErrors.

See Also:

Constant Field Values

PROMPT_VALIDATION_ERROR_LOWER_RANGE_VALUE_ABOVE_MAXIMUM_LENGTH

static final long PROMPT_VALIDATION_ERROR_LOWER_RANGE_VALUE_ABOVE_MAXIMUM_LENGTH

Error code possibly returned from getPromptValueValidationErrors.

See Also:

Constant Field Values

PROMPT_VALIDATION_ERROR_UPPER_RANGE_VALUE_BELOW_MINIMUM_LENGTH

static final long PROMPT_VALIDATION_ERROR_UPPER_RANGE_VALUE_BELOW_MINIMUM_LENGTH

Error code possibly returned from getPromptValueValidationErrors.

See Also:

Constant Field Values

PROMPT_VALIDATION_ERROR_UPPER_RANGE_VALUE_ABOVE_MAXIMUM_LENGTH

static final long PROMPT_VALIDATION_ERROR_UPPER_RANGE_VALUE_ABOVE_MAXIMUM_LENGTH

Error code possibly returned from getPromptValueValidationErrors.

See Also:

Constant Field Values

PROMPT_VALIDATION_ERROR_NON_EDITABLE_REQUIRED_WITH_NO_DEFAULT_NOT_ALLOWED

static final long PROMPT_VALIDATION_ERROR_NON_EDITABLE_REQUIRED_WITH_NO_DEFAULT_NOT_ALLOWED

Error code possibly returned from getPromptValueValidationErrors.

See Also:

Constant Field Values

PROMPT_VALIDATION_ERROR_SPECIAL_VALUE_MIXED_WITH_OTHER_VALUES

static final long PROMPT_VALIDATION_ERROR_SPECIAL_VALUE_MIXED_WITH_OTHER_VALUES

Error code possibly returned from getPromptValueValidationErrors.

See Also:

Constant Field Values

PROMPT_VALIDATION_ERROR_MORE_THAN_ONE_SPECIAL_VALUE_SPECIFIED

static final long PROMPT_VALIDATION_ERROR_MORE_THAN_ONE_SPECIAL_VALUE_SPECIFIED

Error code possibly returned from getPromptValueValidationErrors.

See Also:

Constant Field Values

PROMPT_VALIDATION_ERROR_DATA_SOURCE_CONTAINS_NO_DATA_ITEMS

static final long PROMPT_VALIDATION_ERROR_DATA_SOURCE_CONTAINS_NO_DATA_ITEMS

Error code possibly returned from getPromptValueValidationErrors.

See Also:

Constant Field Values

PROMPT_VALIDATION_ERROR_DATA_SOURCE_NOT_AVAILABLE

static final long PROMPT_VALIDATION_ERROR_DATA_SOURCE_NOT_AVAILABLE

Error code possibly returned from getPromptValueValidationErrors.

See Also:

Constant Field Values

PROMPT_VALIDATION_ERROR_DATA_SOURCE_TYPE_NOT_ALLOWED

static final long PROMPT_VALIDATION_ERROR_DATA_SOURCE_TYPE_NOT_ALLOWED

Error code possibly returned from getPromptValueValidationErrors.

See Also:

Constant Field Values

PROMPT_VALIDATION_ERROR_DATA_SOURCE_COLUMN_TYPE_NOT_ALLOWED

static final long PROMPT_VALIDATION_ERROR_DATA_SOURCE_COLUMN_TYPE_NOT_ALLOWED

Error code possibly returned from getPromptValueValidationErrors.

See Also:

Constant Field Values

PROMPT_VALIDATION_ERROR_MULTIPLE_DATA_SOURCES_NOT_ALLOWED

static final long PROMPT_VALIDATION_ERROR_MULTIPLE_DATA_SOURCES_NOT_ALLOWED

Error code possibly returned from getPromptValueValidationErrors.

See Also:

Constant Field Values

PROMPT_VALIDATION_ERROR_STATIC_VALUE_INVALID

static final long PROMPT_VALIDATION_ERROR_STATIC_VALUE_INVALID

Error code possibly returned from getPromptValueValidationErrors.

See Also:

Constant Field Values

PROMPT_VALIDATION_ERROR_MIN_DECIMAL_PLACES_ABOVE_MAX_PERCISION

static final long PROMPT_VALIDATION_ERROR_MIN_DECIMAL_PLACES_ABOVE_MAX_PERCISION

Error code possibly returned from getPromptValueValidationErrors.

See Also:

Constant Field Values

PROMPT_VALIDATION_ERROR_MAX_DECIMAL_PLACES_ABOVE_MAX_PERCISION

static final long PROMPT_VALIDATION_ERROR_MAX_DECIMAL_PLACES_ABOVE_MAX_PERCISION

Error code possibly returned from getPromptValueValidationErrors.

See Also:

Constant Field Values

PROMPT_VALIDATION_ERROR_FILE_TYPE_NOT_ALLOWED

static final long PROMPT_VALIDATION_ERROR_FILE_TYPE_NOT_ALLOWED

Error code possibly returned from getPromptValueValidationErrors.

See Also:

Constant Field Values

PROMPT_VALIDATION_ERROR_ONLY_FILES_ALLOWED

static final long PROMPT_VALIDATION_ERROR_ONLY_FILES_ALLOWED

Error code possibly returned from getPromptValueValidationErrors.

See Also:

Constant Field Values

PROMPT_VALIDATION_ERROR_ONLY_DIRECTORIES_ALLOWED

static final long PROMPT_VALIDATION_ERROR_ONLY_DIRECTORIES_ALLOWED

Error code possibly returned from getPromptValueValidationErrors.

See Also:

Constant Field Values

PROMPT_VALIDATION_ERROR_MASKED_HIDDEN_REQUIRED

static final long PROMPT_VALIDATION_ERROR_MASKED_HIDDEN_REQUIRED

Error code possibly returned from getPromptValueValidationErrors.

See Also:

Constant Field Values

PROMPT_VALIDATION_ERROR_EMPTY_STATIC_LIST_AND_REQUIRED_WITH_NO_ADDITIONAL_VALUES_ALLOWED

static final long PROMPT_VALIDATION_ERROR_EMPTY_STATIC_LIST_AND_REQUIRED_WITH_NO_ADDITIONAL_VALUES_ALLOWED

Error code possibly returned from getPromptValueValidationErrors.

See Also:

Constant Field Values

PROMPT_VALIDATION_ERROR_ERROR_LOADING_SHARED_PROMPT

static final long PROMPT_VALIDATION_ERROR_ERROR_LOADING_SHARED_PROMPT

Error code possibly returned from getPromptValueValidationErrors.

See Also:

Constant Field Values

PROMPT_VALIDATION_ERROR_INVALID_INPUT_PATTERN

static final long PROMPT_VALIDATION_ERROR_INVALID_INPUT_PATTERN

Error code possibly returned from getPromptValueValidationErrors.

See Also:

Constant Field Values

PROMPT_VALIDATION_ERROR_INPUT_DOES_NOT_MATCH_PATTERN

static final long PROMPT_VALIDATION_ERROR_INPUT_DOES_NOT_MATCH_PATTERN

Error code possibly returned from getPromptValueValidationErrors.

See Also:

Constant Field Values

PROMPT_VALIDATION_ERROR_INCORRECT_RELATIVE_DATE_VALUE

static final long PROMPT_VALIDATION_ERROR_INCORRECT_RELATIVE_DATE_VALUE

Error code possibly returned from getPromptValueValidationErrors.

See Also:

Constant Field Values

PROMPT_VALIDATION_ERROR_FROM_SCRIPT

static final long PROMPT_VALIDATION_ERROR_FROM_SCRIPT

Error code possibly returned from getPromptValueValidationErrors.

See Also:

Constant Field Values

Method Detail

getPromptName

java.lang.String getPromptName()

Returns the name of the prompt. This has application specific usage, such as the parameter name for stored process prompts.

Returns:

the name of the prompt

getPromptLabel

java.lang.String getPromptLabel(java.util.Locale locale)

Returns the label used to ask the user for the value of the prompt.

Parameters:

locale - The locale to return the label for

Returns:

the label used to ask the user for the value of the prompt.

getPromptLabels

com.sas.util.LocalizableString getPromptLabels()

Returns a LocalizableString containing the labels for all Locales for which labels are set.

Returns:

LocalizableString a LocalizableString containing the labels for all Locales for which labels are set

getPromptDescription

java.lang.String getPromptDescription(java.util.Locale locale)

Returns the description of the prompt used when asking for the prompts value. This is typically displayed along with the label during input.

Parameters:

locale - The locale to get the scription for

Returns:

the description of the prompt used when asking for the prompts value.

getPromptDescriptions

com.sas.util.LocalizableString getPromptDescriptions()

Returns a LocalizableString containing the descriptions for all Locales for which descriptions are set.

Returns:

a LocalizableString containing the descriptions for all Locales for which descriptions are set

isDefaultValueSet

boolean isDefaultValueSet()

Returns whether the default value for the prompt has been set.

Returns:

whether the default value for the prompt has been set.

See Also:

getDefaultValue()

getDefaultValue

java.lang.Object getDefaultValue()

Returns the default value for the prompt. This is a "fall-back" value in case a value has not been set on the prompt (or one is not otherwise available).

Returns:

the default value for the prompt.

See Also:

isDefaultValueSet(), PromptValuesInterface.getPromptValue(PromptDefinitionInterface)

clearDefaultValue

void clearDefaultValue()

Clears the default value if one has been set.

See Also:

isDefaultValueSet()

getPromptDataType

com.sas.datatypes.DataTypeInterface getPromptDataType()

Returns the data type that this definition uses to store/validate values set on the prompt.

Returns:

the return type will vary depending on the type of prompt

See Also:

DataTypeInterface

isRequired

boolean isRequired()

Returns whether the user is required to supply a value for the prompt before continuing in an application.

Returns:

whether the user is required to supply a value for the prompt before continuing in an application

isHidden

boolean isHidden()

Returns whether the prompt should be hidden at runtime when the user is asked to provide values for prompts.

Returns:

whether the prompt should be hidden at runtime when the user is asked to provide values for prompts

isFixed

boolean isFixed()

Returns whether the prompt value can be modified.

Returns:

whether the prompt value can be modified

isPromptValueValid

@Deprecated
boolean isPromptValueValid(java.lang.Object value)

Deprecated.

Returns whether the value passed in meets the constraints of the prompt.

Parameters:

value - The value to check for validity

Returns:

whether the value passed in meets the constraints of the prompt

getPromptValueValidationErrors

java.util.Collection<ValidationEntry> getPromptValueValidationErrors(java.lang.Object value,
                                                                     java.util.Locale locale)

Returns a Collection containing the set of ValidationEntry objects or an empty collection if no errors were found.

Parameters:

value - The value to check for errors

locale - The locale to return the error messages in

Returns:

A Collection containing the set of ValidationEntry objects or an empty collection if no errors were found.

See Also:

getPromptValueValidationErrors(Object, Locale)

validateDefinition

java.util.Collection<ValidationEntry> validateDefinition(java.util.Locale locale)

This method is used to validate that the various attributes of the definition all contain valid values. If the definition is valid, and empty collection will be returned, otherwise the collection with contain ValidationEntry objects for each error. This method should be called before the definition is to be used.

Parameters:

locale - The locale to return the error messages in

Returns:

A Collection containing the set of ValidationEntry objects or an empty collection if no errors were found.

See Also:

validateDefinition(Locale)

getUserInfo

com.sas.util.UserInfoInterface getUserInfo()

Returns a UserInfoInterface instance which is a String to String Map of additional information that the prompt has. Implementations should never return null, but an instanceof of UserInfoInterface instead.

Returns:

a UserInfoInterface instance