com.avaje.ebean.BeanState 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
/**
 * Copyright (C) 2006  Robin Bygrave
 * 
 * This file is part of Ebean.
 * 
 * Ebean is free software; you can redistribute it and/or modify it 
 * under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation; either version 2.1 of the License, or
 * (at your option) any later version.
 *  
 * Ebean is distributed in the hope that it will be useful, but 
 * WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License for more details.
 * 
 * You should have received a copy of the GNU Lesser General Public License
 * along with Ebean; if not, write to the Free Software Foundation, Inc.,
 * 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA  
 */
package com.avaje.ebean;

import java.beans.PropertyChangeListener;
import java.util.Set;

/**
 * Provides access to the internal state of an entity bean.
 */
public interface BeanState {

	/**
	 * Return true if this is a lazy loading reference bean.
	 * 
	 * If so the this bean only holds the Id property and will invoke lazy
	 * loading if any other property is get or set.
	 * 
	 */
	public boolean isReference();

	/**
	 * Return true if the bean is new (and not yet saved).
	 */
	public boolean isNew();

	/**
	 * Return true if the bean is new or dirty (and probably needs to be saved).
	 */
	public boolean isNewOrDirty();

	/**
	 * Return true if the bean has been changed but not yet saved.
	 */
	public boolean isDirty();

	/**
	 * For partially populated beans returns the properties that are loaded on
	 * the bean.
	 * 
	 * Accessing another property will cause lazy loading to occur.
	 * 
	 */
	public Set getLoadedProps();

	/**
	 * Return the set of changed properties.
	 */
    public Set getChangedProps();

	/**
	 * Return true if the bean is readOnly.
	 * 
	 * If a setter is called on a readOnly bean it will throw an exception.
	 * 
	 */
	public boolean isReadOnly();

	/**
	 * Set the readOnly status for the bean.
	 */
	public void setReadOnly(boolean readOnly);

	/**
	 * Add a propertyChangeListener.
	 */
	public void addPropertyChangeListener(PropertyChangeListener listener);

	/**
	 * Remove a propertyChangeListener.
	 */
	public void removePropertyChangeListener(PropertyChangeListener listener);

	/**
	 * Advanced - Used to programmatically build a reference object.
	 * 
	 * You can create a new EntityBean (
	 * {@link EbeanServer#createEntityBean(Class)}, set its Id property and then
	 * call this setReference() method.
	 * 
	 */
	public void setReference();

	/**
	 * Advanced - Used to programmatically build a partially or fully loaded
	 * entity bean. First create an entity bean via
	 * {@link EbeanServer#createEntityBean(Class)}, then populate its properties
	 * and then call this method specifying which properties where loaded or
	 * null for a fully loaded entity bean.
	 * 
	 * @param loadedProperties
	 *            the properties that where loaded or null for a fully loaded
	 *            entity bean.
	 */
	public void setLoaded(Set loadedProperties);
}