com.kenshoo.pl.entity.spi.ImmutableFieldValidator 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.spi;

import com.kenshoo.pl.entity.CurrentEntityState;
import com.kenshoo.pl.entity.EntityField;
import com.kenshoo.pl.entity.EntityType;

import java.util.function.Predicate;
import java.util.stream.Stream;

/**
 * A validator that prevents a field from being modified (can only be set by a CREATE command).
 *
 * @param  entity type
 * @param  immutable field type
 */
public interface ImmutableFieldValidator, T> extends ChangeValidator {

    /**
     * @return the field that should not be modified
     */
    EntityField immutableField();

    /**
     * @return the error code to return if a modification of the field is attempted
     */
    String getErrorCode();

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

    /**
     * The predicate is evaluated on the current state of the entity See {@link CurrentEntityState}.
     * @return a predicate indicating when the field should be validated. It will be evaluated together with {@link #fetchFields()},
     * which means that all the fields appearing in the predicate must also be included in the fields to fetch.
     */
    default Predicate immutableWhen() {
        return e -> true;
    }


}