com.sas.prompts.definitions
Class DateDefinition

com.sas.prompts.definitions.DateDefinition
All Implemented Interfaces:
com.sas.models.VersionInterface, com.sas.prompts.definitions.DateDefinitionInterface, com.sas.prompts.definitions.DateDefinitionV2Interface, com.sas.prompts.definitions.DateDefinitionV3Interface, com.sas.prompts.definitions.HintableDefinitionInterface, com.sas.prompts.definitions.HintableDefinitionV2Interface, com.sas.prompts.definitions.MutableDateDefinitionInterface, com.sas.prompts.definitions.MutableDateDefinitionV2Interface, com.sas.prompts.definitions.MutableDateDefinitionV3Interface, 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, MutableSelectableDefinitionInterface, MutableValueProviderDefinitionInterface, com.sas.prompts.definitions.MutableValueRetrieverDefinitionInterface, PromptDefinitionInterface, com.sas.prompts.definitions.PromptDefinitionV2Interface, com.sas.prompts.definitions.PromptDefinitionV3Interface, SelectableDefinitionInterface, com.sas.prompts.definitions.SelectableDefinitionV2Interface, ValueProviderDefinitionInterface, com.sas.prompts.definitions.ValueRetrieverDefinitionInterface, 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.storage.valueprovider.AllowUserValuesInterface, com.sas.uiconfig.ContextEnabledObject, com.sas.util.AttributeConfigurationInterface, com.sas.util.AttributeDescription, com.sas.util.log.ComponentLogFactoryInterface, com.sas.util.macrovar.MacroVariableListOptionInterface, com.sas.util.macrovar.MacroVariableOptionInterface, com.sas.util.macrovar.MutableMacroVariableListOptionInterface, com.sas.util.macrovar.MutableMacroVariableOptionInterface, com.sas.util.MutableSupportedSpecialValuesInterface, com.sas.util.ResourceReferencesInterface, com.sas.util.SupportedSpecialValuesInterface, com.sas.util.xmlpersist.PersistenceInterface, java.io.Externalizable, java.io.Serializable, java.lang.Cloneable

public class DateDefinition
implements com.sas.prompts.definitions.MutableDateDefinitionV3Interface

Since:
9.2
See Also:
Serialized Form

Field Summary
static java.util.Date maximumMaximum
          Date representing the maximum date allowed for the "maximum" property.
static java.util.Date minimumMinimum
          Date representing the minimum date allowed for the "minimum" property.
static com.sas.util.DatePeriod periodInTheFuture
          DatePeriod representing the largest interval allowed for a period in the future.
static com.sas.util.DatePeriod periodInThePast
          DatePeriod representing the largest interval allowed for a period in the past.
static java.lang.String RB_KEY
           
 
Fields inherited from interface com.sas.prompts.definitions.SelectableDefinitionInterface
MULTIPLE_SELECTION, ORDERED_MULTIPLE_SELECTION, SINGLE_SELECTION
 
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
DateDefinition()
          Constructor
DateDefinition(java.lang.String promptName)
          Constructor for DateDefinition.
 
Method Summary
 java.lang.Object clone()
          Clone this PromptDefinition.
 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.
 java.util.Date getMaximum()
          Returns the maximum allowed date or null if none is set.
 int getMaximumValueCount()
          Returns the maximum number of values the user is allowed to select.
 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.
 int getMinimumValueCount()
          Returns the minimum number of values the user is allowed to select.
 java.util.Date getMinMin()
          Returns the user set minimumMinimum date allowed for the 'minimum' property
 int getPageSize()
          Internal method
 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.
 int getSelectionType()
          Returns the type of selection that the prompt supports.
 com.sas.util.SupportedSpecialValues getSupportedSpecialValues()
           
 com.sas.storage.valueprovider.ValueProviderInterface getValueProvider()
          Returns the value provider to use to access possible values for the prompt.
 com.sas.storage.vr.dto.ValueRetrieverConfiguration getValueRetrieverConfiguration()
          Returns the ValueRetrieverConfiguration instance that was set, if any.
 java.lang.String getVersion()
           
 boolean isAllowUserValues()
           
 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'
 boolean isRequired()
          Returns whether the prompt value is required to be set before the user can continue with the operation being prompted for.
 boolean isSelectionOrdered()
          Returns whether the values the user selects should be ordered.
 void setAllowUserValues(boolean allowValues)
          Sets whether the user should be allowed to specify values in addition to those returned by the value provider.
 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 setLoggerFactory(com.sas.util.log.LoggerFactoryInterface factory)
          Sets the factory that will provide the desired logger implementation.
 void setMaximum(java.util.Date maximum)
          Sets the maximum allowed date.
 void setMaximumValueCount(int maximumValueCount)
          Sets the maximum number of valid values for a prompt.
 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 setMinimumValueCount(int minimumValueCount)
          Sets the minimum number of valid values for a prompt.
 void setMinMin(java.util.Date minMin)
          Set the minimumMinimum date allowed for the 'minimum' property.
 void setPageSize(int pageSize)
          Internal method
 void setSelectionOrdered(boolean selectionOrdered)
          Sets whether the order in which values are selected should be retained.
 void setSupportedSpecialValues(com.sas.util.SupportedSpecialValues specialValuesSupported)
           
 void setValueProvider(com.sas.storage.valueprovider.ValueProviderInterface valueProvider)
          Sets the value provider which will be used to determine the set of possible values for the prompt.
 void setValueRetrieverConfiguration(com.sas.storage.vr.dto.ValueRetrieverConfiguration config)
          Sets the ValueRetrieverConfiguration instance.
 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.
 boolean validIndividualValue(java.lang.Object value, java.util.Locale locale)
          Validates an individual value in a locale-specific way as appropriate.
 
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
 

Field Detail

RB_KEY

public static final java.lang.String RB_KEY
See Also:
Constant Field Values

minimumMinimum

public static final java.util.Date minimumMinimum
Date representing the minimum date allowed for the "minimum" property.


maximumMaximum

public static final java.util.Date maximumMaximum
Date representing the maximum date allowed for the "maximum" property.


periodInThePast

public static final com.sas.util.DatePeriod periodInThePast
DatePeriod representing the largest interval allowed for a period in the past.


periodInTheFuture

public static final com.sas.util.DatePeriod periodInTheFuture
DatePeriod representing the largest interval allowed for a period in the future.

Constructor Detail

DateDefinition

public DateDefinition()
Constructor


DateDefinition

public DateDefinition(java.lang.String promptName)
Constructor for DateDefinition.

Parameters:
promptName - The name of the prompt as String
Method Detail

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)

getMinMin

public java.util.Date getMinMin()
Returns the user set minimumMinimum date allowed for the 'minimum' property

Specified by:
getMinMin in interface com.sas.prompts.definitions.DateDefinitionV3Interface
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.MutableDateDefinitionV3Interface
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 com.sas.prompts.definitions.DateDefinitionV3Interface
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.MutableDateDefinitionV3Interface
Parameters:
maxMax - date allowed for the 'maximum' property

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.DateDefinitionInterface
Returns:
the maximum allowed date.
See Also:
DateDefinitionInterface.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.MutableDateDefinitionInterface
Parameters:
maximum - the maximum allowed date.

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.DateDefinitionInterface
Returns:
the minimum allowed date.
See Also:
DateDefinitionInterface.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.MutableDateDefinitionInterface
Parameters:
minimum - the minimum allowed date.

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.DateDefinitionInterface
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.MutableDateDefinitionInterface
Parameters:
dateType - the type of date, time or timestamp value allowed for this prompt.
See Also:
MutableDateDefinitionInterface.setDateType(DateTypes)

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.DateType, com.sas.datatypes.TimeType, com.sas.datatypes.TimeStampType, com.sas.datatypes.WeekType, com.sas.datatypes.MonthType, com.sas.datatypes.QuarterType, com.sas.datatypes.YearType, or com.sas.datatypes.WeekdayType.

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()

isRequired

public boolean isRequired()
Description copied from class: PromptDefinition
Returns whether the prompt value is required to be set before the user can continue with the operation being prompted for.

Specified by:
isRequired in interface PromptDefinitionInterface
Specified by:
isRequired in class PromptDefinition
Returns:
whether the prompt value is required to be set.
See Also:
PromptDefinitionInterface.isRequired()

getMaximumValueCount

public int getMaximumValueCount()
Description copied from interface: SelectableDefinitionInterface
Returns the maximum number of values the user is allowed to select.

Specified by:
getMaximumValueCount in interface SelectableDefinitionInterface
Returns:
the maximum number of values the user is allowed to select

getMinimumValueCount

public int getMinimumValueCount()
Description copied from interface: SelectableDefinitionInterface
Returns the minimum number of values the user is allowed to select.

Specified by:
getMinimumValueCount in interface SelectableDefinitionInterface
Returns:
the minimum number of values the user is allowed to select

getSelectionType

public int getSelectionType()
Description copied from interface: SelectableDefinitionInterface
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.

Specified by:
getSelectionType in interface SelectableDefinitionInterface
Returns:
An integer corresponding to SINGLE_SELECTION, MULTIPLE_SELECTION, ORDERED_MULTIPLE_SELECTION

isSelectionOrdered

public boolean isSelectionOrdered()
Description copied from interface: SelectableDefinitionInterface
Returns whether the values the user selects should be ordered.

Specified by:
isSelectionOrdered in interface SelectableDefinitionInterface
Returns:
whether the values the user selects should be ordered.

setMaximumValueCount

public void setMaximumValueCount(int maximumValueCount)
Description copied from interface: MutableSelectableDefinitionInterface
Sets the maximum number of valid values for a prompt.

Specified by:
setMaximumValueCount in interface MutableSelectableDefinitionInterface
Parameters:
maximumValueCount - the maximum number of valid values for a prompt.

setMinimumValueCount

public void setMinimumValueCount(int minimumValueCount)
Description copied from interface: MutableSelectableDefinitionInterface
Sets the minimum number of valid values for a prompt.

Specified by:
setMinimumValueCount in interface MutableSelectableDefinitionInterface
Parameters:
minimumValueCount - the minimum number of valid values for a prompt.

setSelectionOrdered

public void setSelectionOrdered(boolean selectionOrdered)
Description copied from interface: MutableSelectableDefinitionInterface
Sets whether the order in which values are selected should be retained.

Specified by:
setSelectionOrdered in interface MutableSelectableDefinitionInterface
Parameters:
selectionOrdered - whether the order in which values are selected should be retained.

getValueProvider

public com.sas.storage.valueprovider.ValueProviderInterface getValueProvider()
Description copied from interface: ValueProviderDefinitionInterface
Returns the value provider to use to access possible values for the prompt.

Specified by:
getValueProvider in interface ValueProviderDefinitionInterface
Returns:
the value provider to use to access possible values for the prompt

isAllowUserValues

public boolean isAllowUserValues()
Specified by:
isAllowUserValues in interface com.sas.storage.valueprovider.AllowUserValuesInterface

setValueProvider

public void setValueProvider(com.sas.storage.valueprovider.ValueProviderInterface valueProvider)
Description copied from interface: MutableValueProviderDefinitionInterface
Sets the value provider which will be used to determine the set of possible values for the prompt. This may be a dynamic value provider which reads from a dataset, or is may be a StaticValueProvider which holds the possble set of values in memory.

Specified by:
setValueProvider in interface MutableValueProviderDefinitionInterface
Parameters:
valueProvider - the value provider which will be used to determine the set of possible values for the prompt.

setAllowUserValues

public void setAllowUserValues(boolean allowValues)
Description copied from interface: MutableValueProviderDefinitionInterface
Sets whether the user should be allowed to specify values in addition to those returned by the value provider.

Specified by:
setAllowUserValues in interface MutableValueProviderDefinitionInterface
Parameters:
allowValues - whether the user should be allowed to specify values in addition to those returned by the value provider.

getPageSize

public int getPageSize()
Description copied from interface: ValueProviderDefinitionInterface
Internal method

Specified by:
getPageSize in interface ValueProviderDefinitionInterface

setPageSize

public void setPageSize(int pageSize)
Description copied from interface: MutableValueProviderDefinitionInterface
Internal method

Specified by:
setPageSize in interface MutableValueProviderDefinitionInterface

getSupportedSpecialValues

public com.sas.util.SupportedSpecialValues getSupportedSpecialValues()
Specified by:
getSupportedSpecialValues in interface com.sas.util.SupportedSpecialValuesInterface

setSupportedSpecialValues

public void setSupportedSpecialValues(com.sas.util.SupportedSpecialValues specialValuesSupported)
Specified by:
setSupportedSpecialValues in interface com.sas.util.MutableSupportedSpecialValuesInterface

setLoggerFactory

public void setLoggerFactory(com.sas.util.log.LoggerFactoryInterface factory)
Description copied from class: BaseAbstractPersistence
Sets the factory that will provide the desired logger implementation. The logger factory can be com.sas.util.log.fs.ServicesLogFactory for the SAS Logging Service or you can get Log4J logging from com.sas.util.log.Log4JFactory. With deprecation of the Logging Service in 9.3, this method is unnecessary and does nothing.

Specified by:
setLoggerFactory in interface com.sas.util.log.ComponentLogFactoryInterface
Overrides:
setLoggerFactory in class com.sas.util.xmlpersist.impl.BaseAbstractPersistence

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 PromptDefinition

getAttributeDescriptors

public java.util.List getAttributeDescriptors(java.util.Locale locale)
Specified by:
getAttributeDescriptors in interface com.sas.util.AttributeDescription
Overrides:
getAttributeDescriptors in class PromptDefinition

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.MutableDateDefinitionV2Interface
Parameters:
dateRelativity -

getDateRelativity

public java.lang.String getDateRelativity()
Description copied from interface: DateDefinitionV2Interface
Returns the dateRelativity constraint for the relative date

Specified by:
getDateRelativity in interface com.sas.prompts.definitions.DateDefinitionV2Interface

isRelativeAllowed

public boolean isRelativeAllowed()
Returns 'false' when the relativity is set to PromptConstants.relativeToNone Else it returns ' true'

Returns:

setValueRetrieverConfiguration

public void setValueRetrieverConfiguration(com.sas.storage.vr.dto.ValueRetrieverConfiguration config)
Description copied from interface: MutableValueRetrieverDefinitionInterface
Sets the ValueRetrieverConfiguration instance.

Specified by:
setValueRetrieverConfiguration in interface com.sas.prompts.definitions.MutableValueRetrieverDefinitionInterface

getValueRetrieverConfiguration

public com.sas.storage.vr.dto.ValueRetrieverConfiguration getValueRetrieverConfiguration()
Description copied from interface: ValueRetrieverDefinitionInterface
Returns the ValueRetrieverConfiguration instance that was set, if any.

Specified by:
getValueRetrieverConfiguration in interface com.sas.prompts.definitions.ValueRetrieverDefinitionInterface
Returns:

clone

public java.lang.Object clone()
                       throws java.lang.CloneNotSupportedException
Description copied from class: PromptDefinition
Clone this PromptDefinition.

Specified by:
clone in interface com.sas.PublicClonable
Overrides:
clone in class PromptDefinition
Returns:
a clone of the prompt
Throws:
java.lang.CloneNotSupportedException

getVersion

public java.lang.String getVersion()
Specified by:
getVersion in interface com.sas.models.VersionInterface
Overrides:
getVersion in class PromptDefinition

validIndividualValue

public boolean validIndividualValue(java.lang.Object value,
                                    java.util.Locale locale)
Description copied from interface: SelectableDefinitionV2Interface
Validates an individual value in a locale-specific way as appropriate. Locale may not be null.

Specified by:
validIndividualValue in interface com.sas.prompts.definitions.SelectableDefinitionV2Interface
Returns:



Copyright © 2009 SAS Institute Inc. All Rights Reserved.