org.datanucleus.api.jdo.annotations.SoftDelete Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of datanucleus-api-jdo Show documentation

Plugin providing DataNucleus implementation of the JDO API.

There is a newer version: 6.0.4

/**********************************************************************
Copyright (c) 2017 Andy Jefferson and others. All rights reserved.
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.

Contributors:
    ...
**********************************************************************/
package org.datanucleus.api.jdo.annotations;

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

import javax.jdo.annotations.Column;

/**
 * Extension annotation allowing for specifying a class as using soft delete, meaning that it will have a surrogate column in its table storing 
 * whether it is deleted (rather than deleting it).
 */
@Target({ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
public @interface SoftDelete
{
    /**
     * Name of the soft delete flag column in the table for this class.
     * @return The soft delete column name
     */
    String column() default "DELETED";

    /**
     * The column making up the soft delete indicator.
     * @return the column making up the soft delete indicator.
     */
    Column[] columns() default {};

    /**
     * Whether the soft delete column is indexed.
     * @return whether the soft delete column is indexed
     */
    String indexed() default "";
}