io.github.astrapi69.data.activatable.Activatable Maven / Gradle / Ivy

Go to download

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

This api project provides interfaces that data objects(for instance jpa entities) can implement for providing several features

The newest version!

/**
 * The MIT License
 *
 * Copyright (C) 2018 Asterios Raptis
 *
 * 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 io.github.astrapi69.data.activatable;

/**
 * The interface {@link Activatable} can be implemented from an data that needs a trigger to set if
 * the data is active or not.
 */
public interface Activatable
{

	/** The Constant for the column name 'active'. */
	String COLUMN_NAME_ACTIVE = "active";

	/**
	 * Checks if the data is active
	 *
	 * @return true, if the data is active otherwise false
	 */
	boolean isActive();

	/**
	 * Sets the active flag
	 *
	 * @param active
	 *            the new active
	 */
	void setActive(boolean active);
}