Pip-Services-Commons-Dotnet
|
Schema to validate user defined objects. More...
Public Member Functions | |
ObjectSchema | AllowUndefined (bool value) |
Sets flag to allow undefined properties. This method returns reference to this exception to implement Builder pattern to chain additional calls. More... | |
ObjectSchema | WithProperty (PropertySchema schema) |
Adds a validation schema for an object property. More... | |
ObjectSchema | WithRequiredProperty (string name, object type, params IValidationRule[] rules) |
Adds a validation schema for a required object property. More... | |
ObjectSchema | WithOptionalProperty (string name, object type, params IValidationRule[] rules) |
Adds a validation schema for an optional object property. More... | |
![]() | |
Schema () | |
Creates a new instance of validation schema. More... | |
Schema (bool required, List< IValidationRule > rules) | |
Creates a new instance of validation schema and sets its values. More... | |
Schema | MakeRequired () |
Makes validated values always required (non-null). For null values the schema will raise errors. More... | |
Schema | MakeOptional () |
Makes validated values optional. Validation for null values will be skipped. More... | |
Schema | WithRule (IValidationRule rule) |
Adds validation rule to this schema. This method returns reference to this exception to implement Builder pattern to chain additional calls. More... | |
List< ValidationResult > | Validate (object value) |
Validates the given value and results validation results. More... | |
void | ValidateAndThrowException (string correlationId, object value, bool strict=false) |
Validates the given value and returns a ValidationException if errors were found. More... | |
Properties | |
List< PropertySchema > | Properties [get, set] |
bool | IsUndefinedAllowed [get, set] |
![]() | |
bool | IsRequired [get, set] |
List< IValidationRule > | Rules [get, set] |
Additional Inherited Members | |
![]() | |
void | PerformTypeValidation (string path, object type, object value, List< ValidationResult > results) |
Validates a given value to match specified type. The type can be defined as a Schema, type, a type name or TypeCode When type is a Schema, it executes validation recursively against that Schema. More... | |
Schema to validate user defined objects.
ObjectSchema PipServices3.Commons.Validate.ObjectSchema.AllowUndefined | ( | bool | value | ) |
Sets flag to allow undefined properties. This method returns reference to this exception to implement Builder pattern to chain additional calls.
value | true to allow undefined properties and false to disallow. |
ObjectSchema PipServices3.Commons.Validate.ObjectSchema.WithOptionalProperty | ( | string | name, |
object | type, | ||
params IValidationRule [] | rules | ||
) |
Adds a validation schema for an optional object property.
name | a property name. |
type | (optional) a property schema or type. |
rules | (optional) a list of property validation rules. |
ObjectSchema PipServices3.Commons.Validate.ObjectSchema.WithProperty | ( | PropertySchema | schema | ) |
Adds a validation schema for an object property.
This method returns reference to this exception to implement Builder pattern to chain additional calls.
schema | a property validation schema to be added. |
See PropertySchema
ObjectSchema PipServices3.Commons.Validate.ObjectSchema.WithRequiredProperty | ( | string | name, |
object | type, | ||
params IValidationRule [] | rules | ||
) |
Adds a validation schema for a required object property.
name | a property name. |
type | (optional) a property schema or type. |
rules | (optional) a list of property validation rules. |