com.kenshoo.pl.entity.spi.audit.AncestorFieldsProvider Maven / Gradle / Ivy

Go to download
package com.kenshoo.pl.entity.spi.audit;

import com.kenshoo.pl.entity.EntityField;

import java.util.stream.Stream;

/**
 * Provides additional fields from ancestor entities that should be added to an {@link com.kenshoo.pl.entity.audit.AuditRecord} of a given entity type.

 * These fields can be used to filter / group the audit records in queries.

 * @see com.kenshoo.pl.entity.annotation.audit.Audited
 */
public interface AncestorFieldsProvider {

    /**
     * @return ancestor fields which should be added to an {@link com.kenshoo.pl.entity.audit.AuditRecord}
     */
    Stream> getFields();


    /**
     * Empty implementation in case no ancestor fields are needed
     */
    final class EmptyAncestorFieldsProvider implements AncestorFieldsProvider {

        @Override
        public Stream> getFields() {
            return Stream.empty();
        }
    }
}