Expected to be called internally by ValueHostsManager/ValidationManager, which supplies the current ValueHostsConfig object. It will be cloned, and not modified directly.
Protected servicesProtected loggerProvides an API for logging, sending entries to the loggerService.
Protected baseProtected overriddenA ValueHostManagerConfig that is getting overridden ValueHost configurations. Each are created by the addOverride() function. They retain a reference to services.
Protected createSupplies the ValidationManagerStartFluent object, already setup
Fluent format to create a InputValueHostConfig. This is the start of a fluent series. Extend series with validation rules like "required()".
the ValueHost name
Optional dataType: null | stringoptional and can be null. The value for ValueHost.dataType.
Optional parameters: FluentInputParametersoptional. Any additional properties of a InputValueHostConfig.
FluentValidatorBuilder for chaining validators to initial InputValueHost
Fluent format to create a InputValueHostConfig. This is the start of a fluent series. Extend series with validation rules like "required()".
the ValueHost name
optional. Any additional properties of a InputValueHostConfig.
FluentValidatorBuilder for chaining validators to initial InputValueHost
Fluent format to create a InputValueHostConfig. This is the start of a fluent series. Extend series with validation rules like "required()".
Supply the entire InputValueHostConfig. This is a special use case. You can omit the valueHostType property.
FluentValidatorBuilder for chaining validators to initial InputValueHost
Fluent format to create a PropertyValueHostConfig. This is the start of a fluent series. Extend series with validation rules like "required()".
the ValueHost name
Optional dataType: null | stringoptional and can be null. The value for ValueHost.dataType.
Optional parameters: FluentPropertyParametersoptional. Any additional properties of a PropertyValueHostConfig.
FluentValidatorBuilder for chaining validators to initial PropertyValueHost
Fluent format to create a PropertyValueHostConfig. This is the start of a fluent series. Extend series with validation rules like "required()".
the ValueHost name
optional. Any additional properties of a PropertyValueHostConfig.
FluentValidatorBuilder for chaining validators to initial PropertyValueHost
Fluent format to create a PropertyValueHostConfig. This is the start of a fluent series. Extend series with validation rules like "required()".
Supply the entire PropertyValueHostConfig. This is a special use case. You can omit the valueHostType property.
FluentValidatorBuilder for chaining validators to initial PropertyValueHost
If it finds the validator with the errorcode specified, it will combine the condition with the existing condition using a rule supplied or callback to let you create a conditionConfig. If it the validator is not found, it will throw an error and log. If the ValueHost is on an earlier override or baseConfig, a new entry is made in the current override, reflecting the same data as earlier, but now with a modified validator. If the ValueHost is on the current override, the existing entry is modified.
The resulting ValidatorConfig's errorCode will not have changed from the original to ensure it aligns with everything depending on the original error code.
A function to create a conditionConfig that will replace the existing. You are passed a Builder object, where you can build your new conditions, and the existing conditionConfig, which can be added to a Builder object with the conditionConfig() function.
modifier.combineWithRule('Field1', 'NotNull',
(combiningBuilder, existingConditionConfig)=> {
combiningBuilder.when(
(enablerBuilder)=> enablerBuilder.equalToValue('YES', 'Field2'),
(childBuilder)=> childBuilder.conditionConfig(existingConditionConfig));
});
Uses the combineUsing parameter to determine how to combine the conditions.
A function to create the condition that you want to combine with the existing condition.
modifier.combineWithRule('Field1', 'NotNull', CombineUsingCondition.When,
(combiningBuilder)=> combiningBuilder.equalToValue('YES', 'Field2'));
Replace the condition supplying the replacement conditionConfig directly. If it finds the validator with the errorcode specified, it will replace the condition with the existing condition. If not, it logs and throws an error. If the ValueHost is on an earlier override or baseConfig, a new entry is made in the current override, reflecting the same data as earlier, but now with a modified validator. If the ValueHost is on the current override, the existing entry is modified.
The resulting ValidatorConfig's errorCode will not have changed from the original to ensure it aligns with everything depending on the original error code.
provide a complete ConditionConfig as the replacement
Replace supplying the replacement condition through a Builder object.
Use a function to create a conditionConfig that will replace the existing. You are passed the builder, where you can build your new conditions.
Replace any of the ValidatorConfig properties supported by UI (most are). Not supported (in the domain of the business logic): 'errorCode', 'conditionConfig', 'conditionCreator'
Same instance for chaining.
Add one or more validators to valueHostName using fluent syntax.
let modifier = vm.startModifying();
modifier.addValidatorsTo('Field1').requireText().regExp('expression');
Protected assertProtected addProtected destinationExposes the ValueHostsConfig currently capturing content.
Delivers a complete ValueHostConfig and shuts down this instance. You cannot use the instance after this point.
Creates the same output as complete() but does not modify the baseConfig allowing it to be called multiple times.
Protected applyTrack a new ValueHostConfig in the destinationConfig.
Protected getGets a ValueHostConfig with matching name by looking in previous overrides and the baseConfig. Goal is to find a ValueHostConfig that existed prior to creating the Modifier or using addOverride().
Protected addUtility to use the Fluent system to add a ValueHostConfig to the ValueHostsManagerConfig.
Optional arg2: null | string | Partial<TVHConfig>Optional arg3: Partial<TVHConfig>Protected assertAttaches an enabler Condition to a ValueHost. The Enabler Condition is actually a ConditionConfig object used to create the Condition. This is used to enable or disable the ValueHost based on the condition. If called on a ValueHost already with an enabler, it will replace the existing enabler.
An actual conditionConfig
Using the Builder API
A function that will build the conditionConfig with the Builder API
Protected addFluent format to create any ValueHostConfig based upon ValidatorsValueHostBaseConfig. This is the start of a fluent series. Extend series with validation rules like "required()". Protected because ValueHostManager does not support InputValueHost. ValidationManager offers a public interface.
the ValueHostType to configure
either the ValueHost name for a multiparameter use or InputValueConfig for a single parameter use.
Optional arg2: null | string | Partial<TVHConfig>optional and can be null. The value for ValueHost.dataType or InputValueHostConfig.
Optional arg3: Partial<TVHConfig>optional. Any additional properties of a InputValueHostConfig.
FluentValidatorBuilder for chaining validators to initial InputValueHost
Protected combineCombines a condition with a ValidatorConfig's condition using a rule supplied or callback to let you create a conditionConfig.
The resulting ValidatorConfig's errorCode will not have changed from the original to ensure it aligns with everything depending on the original error code.
the conditionConfig that you want to combine with the new condition.
Either of these:
Optional arg3: ((combiningBuilder) => void)create the condition that you want to combine with the existing condition.
Protected confirmProtected replaceUpdates the conditionConfig property of destinationOfCondition where the replacement is either a conditionConfig or using a Builder object.
If it finds the validator with the errorcode specified, it will replace the condition with the existing condition. If not, it logs and throws an error. If the ValueHost is on an earlier override or baseConfig, a new entry is made in the current override, reflecting the same data as earlier, but now with a modified validator. If the ValueHost is on the current override, the existing entry is modified.
The resulting ValidatorConfig's errorCode will not have changed from the original to ensure it aligns with everything depending on the original error code.
Either of these:
Protected setupReturns a ValueHostConfig that is already in the destinationValueHostConfigs with the desired validatorConfig. If it cannot match both valueHostName and errorCode, it will throw an error.
If 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.
Completes the process by using ValueHostManager.addOrMergeValueHost() on each entry supplied. That function internally uses ValueHostsConfigMergeService when the ValueHost exists. After this function completes, this instance has been disposed (via dispose() function) and the instance should not be used further. Any reference to a ValueHost instance that you have must be abandoned and a fresh instance retrieved, as your reference was disposed.
Protected ensureConfirms the config is of the expected type. Update a specific valueHost's properties.
Protected identifyProtected prepUtility for calls to existing static(), input(), calc(), and property() functions that provide defenses against bad data.
Optional arg2: null | string | FluentStaticParametersOptional parameters: FluentStaticParametersOn update, need some defenses against incoming data.
Optional arg2: null | string | FluentStaticParametersOptional arg3: FluentStaticParametersOn update, need some defenses against incoming data.
Optional dataType: null | stringOptional calcFn: CalculationHandlerGenerated using TypeDoc v0.25.12
Used by ValidationManager.startModifying() function to modify the ValidationManagerConfig.valueHostConfigs array. It does not change the original until you call its apply() function. It makes changes through ValidationManager.addOrMergeValueHost().