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

/**
 * Represents a transient property stored in a command, meaning it is never persisted to the DB.

 * The basic PL flow will ignore these properties and simply carry them through the flow.

 * It can be useful for cases where a client wants to pass additional information to be consumed at the end of the flow, without saving it to the DB.

 * The first use-case to be implemented within PL is a property holding a custom description for auditing.
 */
public interface TransientProperty {

    /**
     * @return a description of what the property represents
     */
    String getDescription();

    /**
     * @return the type of value the property can have
     */
    Class getType();
}