com.sas.prompts.definitions
Interface SelectableDefinitionInterface

All Superinterfaces:

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

All Known Subinterfaces:

MutableSelectableDefinitionInterface

All Known Implementing Classes:

DataSourceColumnDefinition, DateDefinition, DoubleDefinition, IntegerDefinition, ModalGroupDefinition, TextDefinition

public interface SelectableDefinitionInterface
extends PromptDefinitionInterface, com.sas.util.macrovar.MacroVariableListOptionInterface

Interface for prompts which may support multiple values. Allows setting parameters which indicate constraints on multi-value prompt input.

Field Summary

static int	MULTIPLE_SELECTION Selection type indicating that multiple values are allowed.
static int	ORDERED_MULTIPLE_SELECTION Selection type indicating that multiple values are allowed and that the order of the values should be retained.
static int	SINGLE_SELECTION Selection type indicating that only one value is allowed.

Fields inherited from interface com.sas.prompts.definitions.PromptDefinitionInterface

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

Method Summary

int	getMaximumValueCount() Returns the maximum number of values the user is allowed to select.
int	getMinimumValueCount() Returns the minimum number of values the user is allowed to select.
int	getSelectionType() Returns the type of selection that the prompt supports.
boolean	isSelectionOrdered() Returns whether the values the user selects should be ordered.

Methods inherited from interface com.sas.prompts.definitions.PromptDefinitionInterface

clearDefaultValue, getDefaultValue, getPromptDataType, getPromptDescription, getPromptDescriptions, getPromptLabel, getPromptLabels, getPromptName, getPromptValueValidationErrors, getUserInfo, isDefaultValueSet, isFixed, isHidden, isPromptValueValid, isRequired, validateDefinition

Field Detail

SINGLE_SELECTION

static final int SINGLE_SELECTION

Selection type indicating that only one value is allowed.

See Also:

Constant Field Values

MULTIPLE_SELECTION

static final int MULTIPLE_SELECTION

Selection type indicating that multiple values are allowed.

See Also:

Constant Field Values

ORDERED_MULTIPLE_SELECTION

static final int ORDERED_MULTIPLE_SELECTION

Selection type indicating that multiple values are allowed and that the order of the values should be retained.

See Also:

Constant Field Values

Method Detail

getMaximumValueCount

int getMaximumValueCount()

Returns the maximum number of values the user is allowed to select.

Returns:

the maximum number of values the user is allowed to select

getMinimumValueCount

int getMinimumValueCount()

Returns the minimum number of values the user is allowed to select.

Returns:

the minimum number of values the user is allowed to select

getSelectionType

int getSelectionType()

Returns the type of selection that the prompt supports. SINGLE_SELECTION indicates that the user will only be able to select 1 value at a time. MULTIPLE_SELECTION indicates that the user will be able to select multiple values (subject to the maximum value count). ORDERED_MULTIPLE_SELECTION indicates that the user will be able to select multiple values (subject to the maximum value count) and that they will be able to reorder the selected values.

Returns:

An integer corresponding to SINGLE_SELECTION, MULTIPLE_SELECTION, ORDERED_MULTIPLE_SELECTION

isSelectionOrdered

boolean isSelectionOrdered()

Returns whether the values the user selects should be ordered.

Returns:

whether the values the user selects should be ordered.