com.avaje.ebean.event.BeanPersistRequest Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of ebean Show documentation

Ebean

There is a newer version: 2.8.1

package com.avaje.ebean.event;

import java.util.Set;

import com.avaje.ebean.EbeanServer;
import com.avaje.ebean.Transaction;

/**
 * Holds the information available for a bean persist (insert, update or delete).
 * 
 * This is made available for the BeanPersistControllers. 
 * 
 */
public interface BeanPersistRequest {

	/**
	 * Return the server processing the request.
	 */
	public EbeanServer getEbeanServer();

	/**
	 * Return the Transaction associated with this request.
	 */
	public Transaction getTransaction();

	/**
	 * For an update or delete of a partially populated bean this is the 
	 * set of loaded properties and otherwise returns null.
	 */
	public Set getLoadedProperties();

	/**
	 * For an update this is the set of properties that where updated.
	 */
	public Set getUpdatedProperties();
	
	/**
	 * Returns the bean being inserted updated or deleted.
	 */
	public T getBean();
	
	/**
	 * Returns a bean containing the original values prior to the bean being modified.
	 * 
	 * This is for updates only.
	 * 
	 */
	public T getOldValues();
	
}