org.apache.deltaspike.data.api.audit.ModifiedOn Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of deltaspike-data-module-api Show documentation

There is a newer version: 2.0.0

Show newest version

/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements. See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership. The ASF licenses this file
 * to you 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.
 */
package org.apache.deltaspike.data.api.audit;

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

/**
 * Marks a property which should be updated with a timestamp when the entity gets updated.
 * By setting {@link #onCreate()} to {@code true}, the property gets also set when
 * the entity is persisted.
 */
@Retention(RetentionPolicy.RUNTIME)
@Target({ ElementType.FIELD, ElementType.METHOD })
public @interface ModifiedOn
{
    /**
     * Tells whether or not the property shall be set when the entity is first persisted.
     * @deprecated If the property shall be set when the entity is first persisted, use {@link CreatedOn}.
     * @return set this to {@code true} if the property shall be set when the entity is first persisted.
     */
    boolean onCreate() default false;
}