com.kenshoo.pl.entity.internal.validators.EntityChangeValidator Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of persistence-layer Show documentation

A Java persistence layer based on JOOQ for high performance and business flow support.

There is a newer version: 0.1.121-jooq-3.16.3

package com.kenshoo.pl.entity.internal.validators;

import com.kenshoo.pl.entity.CurrentEntityState;
import com.kenshoo.pl.entity.EntityChange;
import com.kenshoo.pl.entity.EntityField;
import com.kenshoo.pl.entity.EntityType;
import com.kenshoo.pl.entity.SupportedChangeOperation;
import com.kenshoo.pl.entity.ValidationError;

import java.util.stream.Stream;

/**
 * A validator that checks number of fields and uses entity and parent fields for the verification.
 *
 * @param  entity type
 */
public interface EntityChangeValidator> {

    /**
     * @return the field validated by this validator
     */
    Stream> validatedFields();

    /**
     * @return the supported change operation
     */
    SupportedChangeOperation getSupportedChangeOperation();

    /**
     * @return a list of fields to fetch
     */
    Stream> fetchFields();

    /**
     * Called by the framework to validate the fields in entity change. The implementation can query the entity only for
     * the fields it has declared in {@link #fetchFields()}.
     *
     * @param entityChange entity change
     * @param currentState existing entity
     *
     * @return a validation error if any, null if none
     */
    ValidationError validate(EntityChange entityChange, CurrentEntityState currentState);

}