net.sixpointsix.carpo.common.model.CarpoEntity Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of carpo-common Show documentation

Common until library for carpo

There is a newer version: 0.7.0

package net.sixpointsix.carpo.common.model;

/**
 * Root interface of entities within the Carpo application.
 *
 * The entity interface is intended to provide only the id and timestamps as the most basic information that other
 * modules could depend on
 *
 * @author Andrew Tarry
 * @since 0.0.1
 */
public interface CarpoEntity {

    /**
     * Get the entity id as a string
     * 
     *     The Carpo entity interface has no opinion on the format of the id. It could be a number, UUID or something else
     *     but it must be able to be represented as a string
     * 
     * 
     *     This method uses the carpoId not just id because some systems will already be using a getId method
     * 
     *
     * @return Entity ID
     */
    String getCarpoId();

    /**
     * Get the timestamp associated with the entity
     *
     * 
     *     A Capo entity should have a timestamp linked with if for audit purposes but it is not a essential
     * 
     *
     * @return Timestamp
     */
    Timestamp getTimestamp();

}