com.sas.prompts.definitions
Class DateRangeDefinition

com.sas.prompts.definitions.DateRangeDefinition

All Implemented Interfaces:

com.sas.models.VersionInterface, com.sas.prompts.definitions.BaseDefinitionRangeInterface, com.sas.prompts.definitions.DateRangeDefinitionInterface, com.sas.prompts.definitions.DateRangeDefinitionV2Interface, DateRangeDefinitionV3Interface, com.sas.prompts.definitions.HintableDefinitionInterface, com.sas.prompts.definitions.HintableDefinitionV2Interface, com.sas.prompts.definitions.MutableBaseDefinitionRangeInterface, com.sas.prompts.definitions.MutableDateRangeDefinitionInterface, com.sas.prompts.definitions.MutableDateRangeDefinitionV2Interface, com.sas.prompts.definitions.MutableDateRangeDefinitionV3Interface, com.sas.prompts.definitions.MutableHintableDefinitionInterface, com.sas.prompts.definitions.MutableHintableDefinitionV2Interface, com.sas.prompts.definitions.MutablePromptDefinitionInterface, com.sas.prompts.definitions.MutablePromptDefinitionV2Interface, com.sas.prompts.definitions.MutablePromptDefinitionV3Interface, MutableRequiredDefinitionInterface, PromptDefinitionInterface, com.sas.prompts.definitions.PromptDefinitionV2Interface, com.sas.prompts.definitions.PromptDefinitionV3Interface, com.sas.prompts.IdentifiablePromptInterface, com.sas.prompts.MutableIdentifiablePromptInterface, com.sas.prompts.MutablePromptHelpInterface, com.sas.prompts.PromptHelpInterface, com.sas.PublicClonable, com.sas.storage.editableproperties.LocalizableProperties, com.sas.storage.editableproperties.MultiLocaleProperties, com.sas.uiconfig.ContextEnabledObject, com.sas.util.AttributeConfigurationInterface, com.sas.util.AttributeDescription, com.sas.util.log.ComponentLogFactoryInterface, com.sas.util.macrovar.MacroVariableOptionInterface, com.sas.util.macrovar.MutableMacroVariableOptionInterface, com.sas.util.ResourceReferencesInterface, com.sas.util.xmlpersist.PersistenceInterface, java.io.Externalizable, java.io.Serializable, java.lang.Cloneable

public class DateRangeDefinition
implements com.sas.prompts.definitions.MutableDateRangeDefinitionV3Interface

DateDefinition is a prompt type which allows the specification of a range of dates by specifying a minimum and maximum date.

See Also:

Serialized Form

Field Summary

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

Constructor Summary

DateRangeDefinition()
Constructor

DateRangeDefinition(java.lang.String promptName)
Constructor

Method Summary

void	configureAttributes(java.util.Map<java.lang.String,?> options, java.util.Map<java.lang.String,?> context)
java.util.List	getAttributeDescriptors(java.util.Locale locale)
protected java.util.Map<java.lang.String,java.lang.String>	getConstraints(java.util.Locale locale)
java.lang.String	getDateRelativity() Returns the dateRelativity constraint for the relative date
com.sas.util.DateTypes	getDateType() Returns the type of date, time or timestamp value allowed for this prompt.
protected java.lang.String	getDefaultMaxLabel(java.util.Locale locale) Returns the default label for the maximum field when one is not set by the user.
protected java.lang.String	getDefaultMinLabel(java.util.Locale locale) Returns the default label for the minimum field when one is not set by the user.
java.util.Date	getMaximum() Returns the maximum allowed date or null if none is set.
java.util.Date	getMaxMax() Returns the user set maximumMaximum date allowed for the 'maximum' property
java.util.Date	getMinimum() Returns the minimum allowed date or null if none is set.
java.util.Date	getMinMin() Returns the user set minimumMinimum date allowed for the 'minimum' property
com.sas.datatypes.DataTypeInterface	getPromptDataType() Returns the data type used to manipulate values for the type of date 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.
java.lang.String	getVersion()
boolean	isPromptValueValid(java.lang.Object value, java.util.Locale locale) Returns whether the specified value meets the constraints on the prompt definition.
boolean	isRelativeAllowed() Returns 'false' when the relativity is set to PromptConstants.relativeToNone Else it returns ' true'
void	setDateRelativity(java.lang.String dateRelativity) This defines the dateRelativity for the Relative Date values.
void	setDateType(com.sas.util.DateTypes dateType) Sets the type of date, time or timestamp value allowed for this prompt.
void	setMaximum(java.util.Date maximum) Sets the maximum allowed date.
void	setMaxMax(java.util.Date maxMax) Set the date allowed for the 'minimum' property.
void	setMinimum(java.util.Date minimum) Sets the minimum allowed date.
void	setMinMin(java.util.Date minMin) Set the minimumMinimum date allowed for the 'minimum' property.
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.

Methods inherited from class com.sas.prompts.definitions.BaseDefinitionRange

getMaxLabel, getMaxLabels, getMinLabel, getMinLabels, isRequired, populateErrorsForMinMax, populateMapWithErrorsForValue, setMaxLabel, setMaxLabels, setMinLabel, setMinLabels, setRequired

Methods inherited from class com.sas.prompts.definitions.PromptDefinition

addUserInfo, clearDefaultValue, getApplicationContext, getCustomErrorMessage, getCustomErrorMessages, getDefaultValue, getDependentPromptsForAttributes, getHint, getHintPlacement, getHints, getInlineHint, getInlineHints, getLabelPlacement, getLocalizableProperties, getMutableUserInfo, getPromptDescription, getPromptDescriptions, getPromptHelp, getPromptID, getPromptLabel, getPromptLabels, getPromptName, getScript, getScripts, getUIConfiguration, getUserInfo, getUserInfoAsText, isDefaultValueSet, isDisplayDefaultValueAsBlank, isFixed, isHidden, isPromptValueValid, isValueClearedForNonSelectedModalChoiceGroup, removeScript, removeUserInfo, setAdditionalCascadeDependencies, setApplicationContext, setCustomErrorMessage, setCustomErrorMessages, setDefaultValue, setDependentPromptsForAttributes, setDisplayDefaultValueAsBlank, setFixed, setHidden, setHint, setHintPlacement, setHints, setInlineHint, setInlineHints, setLabelPlacement, setLocalizableProperties, setPromptDescription, setPromptDescriptions, setPromptHelp, setPromptLabel, setPromptLabels, setPromptName, setScript, setUIConfiguration, setUserInfo, setValueClearedForNonSelectedModalChoiceGroup, toString

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

clearDefaultValue, getDefaultValue, getPromptDescription, getPromptDescriptions, getPromptLabel, getPromptLabels, getPromptName, getUserInfo, isDefaultValueSet, isFixed, isHidden, isPromptValueValid

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

setRequired

Constructor Detail

DateRangeDefinition

public DateRangeDefinition()

Constructor

DateRangeDefinition

public DateRangeDefinition(java.lang.String promptName)

Constructor

Parameters:

promptName - The name of the prompt

Method Detail

getVersion

public java.lang.String getVersion()

Specified by:

getVersion in interface com.sas.models.VersionInterface

Overrides:

getVersion in class PromptDefinition

getMinMin

public java.util.Date getMinMin()

Returns the user set minimumMinimum date allowed for the 'minimum' property

Specified by:

getMinMin in interface DateRangeDefinitionV3Interface

Returns:

user set minimumMinimum value or null if not value set

setMinMin

public void setMinMin(java.util.Date minMin)

Set the minimumMinimum date allowed for the 'minimum' property. If null the default minimumMinimum value will be used.

Specified by:

setMinMin in interface com.sas.prompts.definitions.MutableDateRangeDefinitionV3Interface

Parameters:

minMin - date allowed for the 'minimum' property

getMaxMax

public java.util.Date getMaxMax()

Returns the user set maximumMaximum date allowed for the 'maximum' property

Specified by:

getMaxMax in interface DateRangeDefinitionV3Interface

Returns:

user set maximumMaximum value or null if not value set

setMaxMax

public void setMaxMax(java.util.Date maxMax)

Set the date allowed for the 'minimum' property. If null the default maximumMaximum value will be used.

Specified by:

setMaxMax in interface com.sas.prompts.definitions.MutableDateRangeDefinitionV3Interface

Parameters:

maxMax - date allowed for the 'maximum' property

getDefaultMaxLabel

protected java.lang.String getDefaultMaxLabel(java.util.Locale locale)

Returns the default label for the maximum field when one is not set by the user.

Overrides:

getDefaultMaxLabel in class BaseDefinitionRange

Parameters:

locale - The locale the retrieve the label for

Returns:

the default label for the maximum field when one is not set by the user.

getDefaultMinLabel

protected java.lang.String getDefaultMinLabel(java.util.Locale locale)

Returns the default label for the minimum field when one is not set by the user.

Overrides:

getDefaultMinLabel in class BaseDefinitionRange

Parameters:

locale - The locale the retrieve the label for

Returns:

the default label for the minimum field when one is not set by the user.

getPromptDataType

public com.sas.datatypes.DataTypeInterface getPromptDataType()

Returns the data type used to manipulate values for the type of date prompt. It will be one of com.sas.datatypes.CollectionType, com.sas.datatypes.DateRangeType, or com.sas.datatypes.TimeRangeType, or com.sas.datatypes.TimeStampRangeType.

Specified by:

getPromptDataType in interface PromptDefinitionInterface

Specified by:

getPromptDataType in class PromptDefinition

Returns:

the data type used to manipulate values for the type of date prompt.

See Also:

PromptDefinitionInterface.getPromptDataType()

getMinimum

public java.util.Date getMinimum()

Returns the minimum allowed date or null if none is set.

Specified by:

getMinimum in interface com.sas.prompts.definitions.DateRangeDefinitionInterface

Returns:

the minimum allowed date.

See Also:

DateRangeDefinitionInterface.getMinimum()

setMinimum

public void setMinimum(java.util.Date minimum)

Sets the minimum allowed date. null may be set to indicate no minimum.

Specified by:

setMinimum in interface com.sas.prompts.definitions.MutableDateRangeDefinitionInterface

Parameters:

minimum - the minimum allowed date.

getMaximum

public java.util.Date getMaximum()

Returns the maximum allowed date or null if none is set.

Specified by:

getMaximum in interface com.sas.prompts.definitions.DateRangeDefinitionInterface

Returns:

the maximum allowed date.

See Also:

DateRangeDefinitionInterface.getMaximum()

setMaximum

public void setMaximum(java.util.Date maximum)

Sets the maximum allowed date. null may be set to indicate no maximum.

Specified by:

setMaximum in interface com.sas.prompts.definitions.MutableDateRangeDefinitionInterface

Parameters:

maximum - the maximum allowed date.

isPromptValueValid

public boolean isPromptValueValid(java.lang.Object value,
                                  java.util.Locale locale)

Returns whether the specified value meets the constraints on the prompt definition.

Specified by:

isPromptValueValid in interface com.sas.prompts.definitions.PromptDefinitionV2Interface

Overrides:

isPromptValueValid in class PromptDefinition

Parameters:

value - The value to check for validity.

Returns:

boolean true if the value is valid, false otherwise

See Also:

PromptDefinitionInterface.isPromptValueValid(Object)

getPromptValueValidationErrors

public 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.

Specified by:

getPromptValueValidationErrors in interface PromptDefinitionInterface

Overrides:

getPromptValueValidationErrors in class PromptDefinition

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:

PromptDefinitionInterface.getPromptValueValidationErrors(Object, Locale)

validateDefinition

public 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. Subclasses should override this method to return the appropriate validation errors.

Specified by:

validateDefinition in interface PromptDefinitionInterface

Overrides:

validateDefinition in class PromptDefinition

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:

PromptDefinitionInterface.validateDefinition(Locale)

getDateType

public com.sas.util.DateTypes getDateType()

Returns the type of date, time or timestamp value allowed for this prompt. See com.sas.util.DateTypes for valid types.

Specified by:

getDateType in interface com.sas.prompts.definitions.DateRangeDefinitionInterface

Returns:

the type of date, time or timestamp value allowed for this prompt.

See Also:

DateDefinitionInterface.getDateType()

setDateType

public void setDateType(com.sas.util.DateTypes dateType)

Sets the type of date, time or timestamp value allowed for this prompt. See com.sas.util.DateTypes for valid types.

Specified by:

setDateType in interface com.sas.prompts.definitions.MutableDateRangeDefinitionInterface

Parameters:

dateType - the type of date, time or timestamp value allowed for this prompt.

See Also:

MutableDateDefinitionInterface.setDateType(DateTypes)

configureAttributes

public void configureAttributes(java.util.Map<java.lang.String,?> options,
                                java.util.Map<java.lang.String,?> context)

Specified by:

configureAttributes in interface com.sas.util.AttributeConfigurationInterface

Overrides:

configureAttributes in class BaseDefinitionRange

getAttributeDescriptors

public java.util.List getAttributeDescriptors(java.util.Locale locale)

Specified by:

getAttributeDescriptors in interface com.sas.util.AttributeDescription

Overrides:

getAttributeDescriptors in class BaseDefinitionRange

getConstraints

protected java.util.Map<java.lang.String,java.lang.String> getConstraints(java.util.Locale locale)

Overrides:

getConstraints in class PromptDefinition

setDateRelativity

public void setDateRelativity(java.lang.String dateRelativity)

This defines the dateRelativity for the Relative Date values. The possible values are PromptConstants.relativeToCurrent PromptConstants.relativeToCurrentAndFuture PromptConstants.relativeToFuture PromptConstants.relativeToPast PromptConstants.relativeToPastAndCurrent PromptConstants.relativeToNone PromptConstants.relativeToAll

Specified by:

setDateRelativity in interface com.sas.prompts.definitions.MutableDateRangeDefinitionV2Interface

Parameters:

dateRelativity -

getDateRelativity

public java.lang.String getDateRelativity()

Description copied from interface: DateRangeDefinitionV2Interface

Returns the dateRelativity constraint for the relative date

Specified by:

getDateRelativity in interface com.sas.prompts.definitions.DateRangeDefinitionV2Interface

isRelativeAllowed

public boolean isRelativeAllowed()

Returns 'false' when the relativity is set to PromptConstants.relativeToNone Else it returns ' true'

Returns: