Class ValidationHelper

Provides help functionality for retrieving standard information contained within the ValidationContext when working with a ValidationAttribute

Inheritance

object

ValidationHelper

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: LemonEdge.API.Attributes.Validation

Assembly: LemonEdge.API.dll

Syntax

public class ValidationHelper

Constructors

ValidationHelper()

Declaration

public ValidationHelper()

Fields

BATCH_ITEMS_KEY

Declaration

public const string BATCH_ITEMS_KEY = "batch"

Field Value

Type	Description
string

BATCH_ITEMS_VALIDATED_KEY

Declaration

public const string BATCH_ITEMS_VALIDATED_KEY = "batch-validated"

Field Value

Type	Description
string

CACHE_KEY

Declaration

public const string CACHE_KEY = "cache"

Field Value

Type	Description
string

CONTEXT_KEY

Declaration

public const string CONTEXT_KEY = "context"

Field Value

Type	Description
string

USER_KEY

Declaration

public const string USER_KEY = "user"

Field Value

Type	Description
string

Methods

AddBatchItemsValidated(IDictionary<object, object>, ValidationAttribute, string)

Declaration

public static void AddBatchItemsValidated(IDictionary<object, object> context, ValidationAttribute attributeBatchValidated, string key)

Parameters

Type	Name	Description
IDictionary<object, object>	context
ValidationAttribute	attributeBatchValidated
string	key

AddItemsForBatchValidation(IDictionary<object, object>, IEnumerable<IBaseEntity>)

Declaration

public static void AddItemsForBatchValidation(IDictionary<object, object> context, IEnumerable<IBaseEntity> items)

Parameters

Type	Name	Description
IDictionary<object, object>	context
IEnumerable<IBaseEntity>	items

AreBatchItemsValidated(IDictionary<object, object>, ValidationAttribute, string)

Declaration

public static bool AreBatchItemsValidated(IDictionary<object, object> context, ValidationAttribute attributeBatchValidated, string key)

Parameters

Type	Name	Description
IDictionary<object, object>	context
ValidationAttribute	attributeBatchValidated
string	key

Returns

Type	Description
bool

GetItemsForBatchValidation(IDictionary<object, object>)

Declaration

public static IEnumerable<IBaseEntity> GetItemsForBatchValidation(IDictionary<object, object> context)

Parameters

Type	Name	Description
IDictionary<object, object>	context

Returns

Type	Description
IEnumerable<IBaseEntity>

GetValidationContextItems(ValidationContext)

Returns the standard properties (An IEntityUpdater context, cache and user) held within a ValidationContext

Declaration

public static (IEntityUpdater Updater, IReadOnlyCache Cache, UserInfo User) GetValidationContextItems(ValidationContext context)

Parameters

Type	Name	Description
ValidationContext	context	The validation context to retrieve standard properties from the dictionary property bag

Returns

Type	Description
(IEntityUpdater Updater, IReadOnlyCache Cache, UserInfo User)	The standard properties (An IEntityUpdater context, cache and user) held within a ValidationContext

GetValidationContextItems(object, IReadOnlyCache, UserInfo)

Returns a dictionary of properties that can be user within a ValidationContext

Declaration

public static Dictionary<object, object> GetValidationContextItems(object context, IReadOnlyCache cache, UserInfo user)

Parameters

Type	Name	Description
object	context	The context to add to the dictionary for the ValidationContext
IReadOnlyCache	cache	The cache to add to the dictionary for the ValidationContext
UserInfo	user	The user to add to the dictionary for the ValidationContext

Returns

Type	Description
Dictionary<object, object>	A dictionary of properties that can be user within a ValidationContext

TryValidate(IReadOnlyCache, UserInfo, IServiceContext, IEntityRetriever, IEnumerable<IBaseEntity>, IEnumerable<IBaseEntity>, IEnumerable<IBaseEntity>, IEnumerable<IBaseEntity>, List<ValidationResult>, bool)

Declaration

public static Task<bool> TryValidate(IReadOnlyCache cache, UserInfo user, IServiceContext services, IEntityRetriever context, IEnumerable<IBaseEntity> newItems, IEnumerable<IBaseEntity> updatedItems, IEnumerable<IBaseEntity> deletedItems, IEnumerable<IBaseEntity> exemptFromValidations, List<ValidationResult> failed, bool returnOnFirstError)

Parameters

Type	Name	Description
IReadOnlyCache	cache
UserInfo	user
IServiceContext	services
IEntityRetriever	context
IEnumerable<IBaseEntity>	newItems
IEnumerable<IBaseEntity>	updatedItems
IEnumerable<IBaseEntity>	deletedItems
IEnumerable<IBaseEntity>	exemptFromValidations
List<ValidationResult>	failed
bool	returnOnFirstError

Returns

Type	Description
Task<bool>

Validate(IReadOnlyCache, UserInfo, IServiceContext, IEntityRetriever, IEnumerable<IBaseEntity>, IEnumerable<IBaseEntity>, IEnumerable<IBaseEntity>, IEnumerable<IBaseEntity>)

Declaration

public static Task Validate(IReadOnlyCache cache, UserInfo user, IServiceContext services, IEntityRetriever context, IEnumerable<IBaseEntity> newItems, IEnumerable<IBaseEntity> updatedItems, IEnumerable<IBaseEntity> deletedItems, IEnumerable<IBaseEntity> exemptFromValidations)

Parameters

Type	Name	Description
IReadOnlyCache	cache
UserInfo	user
IServiceContext	services
IEntityRetriever	context
IEnumerable<IBaseEntity>	newItems
IEnumerable<IBaseEntity>	updatedItems
IEnumerable<IBaseEntity>	deletedItems
IEnumerable<IBaseEntity>	exemptFromValidations

Returns

Type	Description
Task

Extension Methods

LinqExtensions.AsArray<T>(T)

LinqExtensions.ToArrayOfOne<T>(T)

LinqExtensions.ToListOfOne<T>(T)

MiscExtensions.SetIfNotEqual<T, TP>(T, Expression<Func<T, TP>>, TP)

WeakReferenceExtensions.WeakReference(object)

SQLExtensions.ToSQLValue(object, bool)

ReflectionExtensions.ClearEventInvocations(object, string)

StringExtensions.ToCSVFormatString(object, Type)