hu.icellmobilsoft.coffee.model.base.IAuditEntity Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of coffee-model-base Show documentation
The newest version!
/*-
 * #%L
 * Coffee
 * %%
 * Copyright (C) 2020 i-Cell Mobilsoft Zrt.
 * %%
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 * #L%
 */
package hu.icellmobilsoft.coffee.model.base;

/**
 * Interface for the identified audit entities. Contains setters, getters for id, version, and for the basic audit fields.
 *
 * @param 
 *            The type of the date. E.g.: {@link java.util.Date}, {@link java.time.OffsetDateTime}, {@link java.time.Instant}
 * @param 
 *            The type of the creator and modifier user
 * @author arnold.bucher
 * @since 1.8.1
 */
public interface IAuditEntity extends IVersionable {

    /**
     * Returns the creation date of the entity
     *
     * @return the creation date of the entity
     */
    DATE getCreationDate();

    /**
     * Sets the creation date of the entity
     *
     * @param creationDate
     *            the new creation date
     */
    void setCreationDate(DATE creationDate);

    /**
     * Returns the modification date of the entity
     *
     * @return the modification date of the entity
     */
    DATE getModificationDate();

    /**
     * Sets the modification date of the entity
     *
     * @param modificationDate
     *            the new modification date
     */
    void setModificationDate(DATE modificationDate);

    /**
     * Returns the creator user of the entity
     *
     * @return the creator user of the entity
     */
    USER getCreatorUser();

    /**
     * Sets the creator user of the entity
     *
     * @param creatorUser
     *            the new creator user
     */
    void setCreatorUser(USER creatorUser);

    /**
     * Returns the modification user of the entity
     *
     * @return the modification user of the entity
     */
    USER getModifierUser();

    /**
     * Sets the modification user of the entity
     *
     * @param modifierUser
     *            the new modification user
     */
    void setModifierUser(USER modifierUser);

}