All Libraries | This Library | Package | Class | Use | Tree | Deprecated | Index | Grand Index | Help
|  | Components |
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## com.sas.prompts.definitions
Class SASLibraryDefinition

    com.sas.prompts.definitions.SASLibraryDefinition

All Implemented Interfaces:
  com.sas.models.VersionInterface, com.sas.prompts.definitions.HintableDefinitionInterface, com.sas.prompts.definitions.HintableDefinitionV2Interface, 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, com.sas.prompts.definitions.MutableSASLibraryDefinitionInterface, PromptDefinitionInterface, com.sas.prompts.definitions.PromptDefinitionV2Interface, com.sas.prompts.definitions.PromptDefinitionV3Interface, com.sas.prompts.definitions.SASLibraryDefinitionInterface, 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 SASLibraryDefinition

implements com.sas.prompts.definitions.MutableSASLibraryDefinitionInterface

Prompt definition allowing the user to enter or pick the location of a SAS library in the SAS Folders metadata tree.

See Also:
  Serialized Form

Field Summary
`static java.lang.String` | `RB_KEY`

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
`SASLibraryDefinition()` Constructor
`SASLibraryDefinition(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 myLocale)`
`com.sas.datatypes.DataTypeInterface` | `getPromptDataType()` Returns an instance of com.sas.datatypes.SASLibraryLocationType that can be used to process values for this 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.
`boolean` | `isPromptValueValid(java.lang.Object value, java.util.Locale locale)` Returns whether the specified value meets the constraints on the prompt definition.
`boolean` | `isRequired()` Returns whether the prompt must have a value before the user is allowed to continue processing.
`void` | `setRequired(boolean required)` Sets whether the prompt must have a value before the user is allowed to continue processing.
`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.PromptDefinition
`addUserInfo, clearDefaultValue, getApplicationContext, getConstraints, getCustomErrorMessage, getCustomErrorMessages, getDefaultValue, getDependentPromptsForAttributes, getHint, getHintPlacement, getHints, getInlineHint, getInlineHints, getLabelPlacement, getLocalizableProperties, getMutableUserInfo, getPromptDescription, getPromptDescriptions, getPromptHelp, getPromptID, getPromptLabel, getPromptLabels, getPromptName, getScript, getScripts, getUIConfiguration, getUserInfo, getUserInfoAsText, getVersion, 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

Constructor Detail

### SASLibraryDefinition

    public SASLibraryDefinition()

  Constructor

### SASLibraryDefinition

    public SASLibraryDefinition(java.lang.String promptName)

  Constructor

Method Detail

### getPromptDataType

    public com.sas.datatypes.DataTypeInterface getPromptDataType()

  Returns an instance of com.sas.datatypes.SASLibraryLocationType that can be used to process values for this prompt.

  Specified by:
    `getPromptDataType` in interface `PromptDefinitionInterface`
  Specified by:
    `getPromptDataType` in class `PromptDefinition`
  Returns:
    an instance of com.sas.datatypes.SASLibraryLocationType
  See Also:
    `PromptDefinitionInterface.getPromptDataType()`

### isRequired

    public boolean isRequired()

  Returns whether the prompt must have a value before the user is allowed to continue processing.

  Specified by:
    `isRequired` in interface `PromptDefinitionInterface`
  Specified by:
    `isRequired` in class `PromptDefinition`
  Returns:
    whether the prompt must have a value before the user is allowed to continue processing
  See Also:
    `PromptDefinitionInterface.isRequired()`

### setRequired

    public void setRequired(boolean required)

  Sets whether the prompt must have a value before the user is allowed to continue processing.

  Specified by:
    `setRequired` in interface `MutableRequiredDefinitionInterface`
  Parameters:
    `required` - whether the prompt must have a value before the user is allowed to continue processing

### 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)`

### 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 myLocale)

  Specified by:
    `getAttributeDescriptors` in interface `com.sas.util.AttributeDescription`
  Overrides:
    `getAttributeDescriptors` in class `PromptDefinition`

All Libraries | This Library | Package | Class | Use | Tree | Deprecated | Index | Grand Index | Help
|  | Components |
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

Copyright © 2009 SAS Institute Inc. All Rights Reserved.