Returns true for a condition with Category=Require. UI can use it to display a "requires a value" indicator.
Value is setup by calling validate(). It does not run validate() itself. Returns false when instanceState.status is Invalid. Any other instanceState.status return true. This follows an old style validation rule of everything is valid when not explicitly marked invalid. That means when it hasn't be run through validation or was undetermined as a result of validation. Recommend using doNotSave for more clarity.
Status from the latest validation, or an indication that validation has yet to occur. It is changed internally and can influence how validation behaves the next time. Prior to calling validate() (or setValue()'s validate option), it is NotAttempted. After setValue it is NeedsValidation. After validate, it may be Valid, Invalid or Undetermined.
When true, an async Validator is running
Exposes the current validation state for the ValueHost. It combines other properties and issuesFound. The same value is delivered to the onValueHostValidationStateChanged callback.
Determines if a validator doesn't consider the ValueHost's value ready to save. True when ValidationStatus is Invalid or NeedsValidation.
Set to true when the user has fixed all invalid validators. Undefined or false otherwise, including if the status changes after this point.
Determines how the validation system sees the Value in terms of editing. When true, it was changed. When false, it was not. The setValue() and related functions are the only ones to change this flag. They all set it to true automatically except set it to false when the option.Reset is true. The ValidatableValueHost.validate() function may skip validation of a ValueHost when isChanged is false, depending on the options for validate(). For example, calling validate immediately after loading up the form, you want to avoid showing Category=Require validators. Those should appear only if the user edits, or when the user attempts to submit.
Readonly valueIf the user needs to abandon this instance, they should use this to clean up active resources (like timers) and to release memory that would stall the garbage collector from disposing this object. It should assign any object reference to undefined as a strong indicator that the object has been disposed.
System consumer assigns the value it also assigns to the input field/element. Its used with RequireTextCondition, DataTypeCheckCondition and RegExpCondition.
Optional options: SetInputValueOptionsvalidate - Invoke validation after setting the value. Reset - Clears validation (except when validate=true) and sets isChanged to false. ConversionErrorTokenValue - When setting the value to undefined, it means there was an error converting. Provide a string here that is a UI friendly error message. It will appear in the Category=Require validator within the {ConversionError} token.
Sets both (native data type) Value and Input Value at the same time and optionally invokes validation. Use when the consuming system resolves both input field/element and native values at the same time so there is one state change and attempt to validate.
Can be undefined to indicate the value could not be resolved from the inputs's value, such as inability to convert a string to a date. All other values, including null and the empty string, are considered real data.
Can be undefined to indicate there is no value. All other values, including null and the empty string, are considered real data.
Optional options: SetValueOptionsvalidate - Invoke validation after setting the value. Reset - Clears validation (except when validate=true) and sets IsChanged to false. ConversionErrorTokenValue - When setting the value to undefined, it means there was an error converting. Provide a string here that is a UI friendly error message. It will appear in the Category=Require validator within the {ConversionError} token.
When the value changes, all other Validatable ValueHosts get notified here so they can rerun validation when any of their Conditions specify the valueHostName that changed.
Runs validation against some of all validators. If at least one validator was NoMatch, it returns ValueHostValidateResult with all of the NoMatches in issuesFound. If all were Matched, it returns ValueHostValidateResult.Value and issuesFound=null. If there are no validators, or all validators were skipped (disabled), it returns ValidationStatus.Undetermined. Updates this ValueHost's InstanceState and notifies parent if changes were made.
Optional options: ValidateOptionsProvides guidance on behavior.
Non-null when there is something to report. null if there was nothing to evaluate which includes all existing validators reporting "Undetermined"
Changes the validation state to itself initial: Undetermined with no error messages.
Optional options: ValidateOptionsOnly supports the skipCallback and Group options.
true when there was something cleared
When Business Logic gathers data from the UI, it runs its own final validation. If its own business rule has been violated, it should be passed here where it becomes exposed to the Validation Summary (getIssuesFound) and optionally for an individual ValueHostName, by specifying that valueHostName in AssociatedValueHostName. Each time called, it adds to the existing list. Use clearBusinessLogicErrors() first if starting a fresh list.
A business logic error to show. If it has an errorCode assigned and the same errorCode is already recorded here, the new entry replaces the old one.
Optional options: ValidateOptionsOnly supports the skipCallback option.
true when a change was made to the known validation state.
Removes any business logic errors. Generally called automatically by ValidationManager as calls are made to SetBusinessLogicErrors and clearValidation().
Optional options: ValidateOptionsOnly supports the skipCallback option.
true when a change was made to the known validation state.
The results of validation specific to one condiiton Type.
same as ConditionType unless you set the ValidatorConfig.errorCode property
The issue or null if none.
A list of all issues found.
Optional group: stringOmit or null to ignore groups. Otherwise this will match to Validatable ValueHosts with the same group (case insensitive match).
An array of issues found. When null, there are no issues and the data is valid. If there are issues, when all have severity = warning, the data is also valid. Anything else means invalid data. Each contains:
Adds or replaces all IssueFound items that are associated with this ValueHost. It ignores those with another ValueHost name, allowing for the same list to be culled by all ValueHosts. (As a result, it never changes the values sent in, or the array itself.) Replacement when the errorCode is the same. Always invokes the onValueHostValidationStateChanged callback.
Use case: client-side getting server-side Jivs-generated IssuesFound, so the UI can incorporate it.
keep or omit an issueFound that does not have a matching validator based on the errorCode.
Gets an Validator already assigned to this ValidatorsValueHostBase.
The errorCode value assigned to the Validator that you want. Same as ConditionType unless you set the ValidatorConfig.errorCode property
The Validator or null if the condition type does not match.
Replaces the value and optionally validates. Call when the value was changed in the system consumer.
Can be undefined to indicate the value could not be resolved from the input field/element's value, such as inability to convert a string to a date. All other values, including null and the empty string, are considered real data. When undefined, IsChanged will still be changed to true unless options.Reset = true.
Optional options: SetValueOptionsvalidate - Invoke validation after setting the value. Reset - Clears validation (except when validate=true) and sets IsChanged to false. ConversionErrorTokenValue - When setting the value to undefined, it means there was an error converting. Provide a string here that is a UI friendly error message. It will appear in the Category=Require validator within the {ConversionError} token.
Identifies that the value is undetermined. For example, the user's input cannot be converted into its native data type or the input is empty. Note this does not reset IsChanged to false without explicitly specifying options.Reset = true;
Optional options: SetValueOptionsvalidate - Invoke validation after setting the value. Reset - Clears validation (except when validate=true) and sets IsChanged to false. ConversionErrorTokenValue - When setting the value to undefined, it means there was an error converting. Provide a string here that is a UI friendly error message. It will appear in the Category=Require validator within the {ConversionError} token.
A name of a data type used to lookup supporting services specific to the data type. See the LookupKey. Some examples: "String", "Number", "Date", "DateTime", "MonthYear"
Adds a custom entry into the ValueHost's InstanceState or removes it when value = undefined.
When undefined, it removes this entry in the state.
Use to retrieve a value from the state that was stored with SaveIntoInstanceState().
Provides a localized label for the data type when it needs to be shown to the user. Since the ValueHostConfig.dataType is optional, this will end up returning the empty string, unless the native value has been assigned and the DataTypeIdentifierService can figure out its lookupKey.
Determines if the ValueHost is enabled for user interaction. It is enabled unless you explicilty set it to false using ValueHostConfig.initialEnabled : false, setup the EnablerCondition which determines when it is enabled, or the ValueHost's own setEnabled() function.
When disabled, the data values of the ValueHost do not get changed by setValue() and related functions. However, those functions offer the overrideDisabled option to force the change.
When disabled and the ValueHost have validators, all validation is disabled and its ValidationStatus reports ValidationState.Disabled.
Sets the enabled state of the ValueHost. When false, the ValueHost is disabled and setValue() and related functions will not change the value. However, they offer the overrideDisabled option to force the change. When disabled and the ValueHost has validators, all validation is disabled and its ValidationStatus reports ValidationState.Disabled.
This value is part of the ValueHost's InstanceState, not the Config, although the ValueHostConfig.initialEnabled is used when it is not set in the state.
A service to provide all ValueHostNames that have been assigned to this Condition's Config.
Generated using TypeDoc v0.25.12
A ValueHost that supports input validation, meaning the value from the user's input, such as from a textbox or tag.
There are two types of values associated with an InputValueHost:
Its up to the system consumer to manage both.