com.wandrell.persistence.PersistenceEntity Maven / Gradle / Ivy

Go to download

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

Repositories and helper classes for making use of persistence on Java.

There is a newer version: 0.1.9

/**
 * The MIT License (MIT)
 * 
 * Copyright (c) 2015 the original author or authors.
 * 

 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 * 

 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 * 

 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 */
package com.wandrell.persistence;

/**
 * Interface for a persistence entity. Gives methods to query and modify the
 * entity's ID.
 * 

 * This is meant to be used with the repositories included on this library.
 * 

 * The ID will be the value contained on the key column for the row where the
 * entity's data is contained.
 * 
 * @author Bernardo Martínez Garrido.
 * @see com.wandrell.persistence.repository repository package
 */
public interface PersistenceEntity {

    /**
     * Returns the ID assigned to this entity.
     * 
     * If no ID has been assigned yet, then the value will be {@code null} or
     * lower than zero.
     * 
     * @return the entity's ID
     */
    public Integer getId();

    /**
     * Sets the ID assigned to this entity.
     * 
     * @param identifier
     *            the ID for the entity
     */
    public void setId(final Integer identifier);

}