breeze-client / ValidationOptions

Class: ValidationOptions

Defined in: src/validation/validation-options.ts:24

A ValidationOptions instance is used to specify the conditions under which validation will be executed.

Implements

• ValidationOptionsConfig

Constructors

Constructor

new ValidationOptions(config?): ValidationOptions

Defined in: src/validation/validation-options.ts:51

ValidationOptions constructor

var newVo = new ValidationOptions( { validateOnSave: false, validateOnAttach: false });
// assume em1 is a preexisting EntityManager
em1.setProperties( { validationOptions: newVo });

Parameters

config?

ValidationOptionsConfig

A configuration object.

Returns

ValidationOptions

Properties

validateOnAttach

validateOnAttach: boolean

Defined in: src/validation/validation-options.ts:29

Whether entity and property level validation should occur when entities are attached to the EntityManager other than via a query. (default = true) Read Only

Implementation of

ValidationOptionsConfig.validateOnAttach

---

validateOnPropertyChange

validateOnPropertyChange: boolean

Defined in: src/validation/validation-options.ts:38

Whether property level validation should occur after entities are modified. (default = true) Read Only

Implementation of

ValidationOptionsConfig.validateOnPropertyChange

---

validateOnQuery

validateOnQuery: boolean

Defined in: src/validation/validation-options.ts:35

Whether entity and property level validation should occur after entities are queried from a remote server. (default = false) Read Only

Implementation of

ValidationOptionsConfig.validateOnQuery

---

validateOnSave

validateOnSave: boolean

Defined in: src/validation/validation-options.ts:32

Whether entity and property level validation should occur before entities are saved. A failed validation will force the save to fail early. (default = true) Read Only

Implementation of

ValidationOptionsConfig.validateOnSave

---

defaultInstance

static defaultInstance: ValidationOptions

Defined in: src/validation/validation-options.ts:88

The default instance for use whenever ValidationOptions are not specified.

Methods

setAsDefault()

setAsDefault(): any

Defined in: src/validation/validation-options.ts:81

Sets the 'defaultInstance' by creating a copy of the current 'defaultInstance' and then applying all of the properties of the current instance. The current instance is returned unchanged.

var validationOptions = new ValidationOptions()
var newOptions = validationOptions.using( { validateOnQuery: true, validateOnSave: false} );
var newOptions.setAsDefault();

Returns

any

---

using()

using(config): ValidationOptions

Defined in: src/validation/validation-options.ts:65

Returns a copy of this ValidationOptions with changes to the specified config properties.

var validationOptions = new ValidationOptions();
var newOptions = validationOptions.using( { validateOnQuery: true, validateOnSave: false} );

Parameters

config

ValidationOptionsConfig

A configuration object

Returns

ValidationOptions

A new ValidationOptions instance.