All Downloads are FREE. Search and download functionalities are using the official Maven repository.

org.hibernate.envers.CrossTypeRevisionChangesReader Maven / Gradle / Ivy

There is a newer version: 7.0.0.Beta1
Show newest version
/*
 * Hibernate, Relational Persistence for Idiomatic Java
 *
 * Copyright (c) 2013, Red Hat Inc. or third-party contributors as
 * indicated by the @author tags or express copyright attribution
 * statements applied by the authors.  All third-party contributions are
 * distributed under license by Red Hat Inc.
 *
 * This copyrighted material is made available to anyone wishing to use, modify,
 * copy, or redistribute it subject to the terms and conditions of the GNU
 * Lesser General Public License, as published by the Free Software Foundation.
 *
 * This program 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 this distribution; if not, write to:
 * Free Software Foundation, Inc.
 * 51 Franklin Street, Fifth Floor
 * Boston, MA  02110-1301  USA
 */
package org.hibernate.envers;

import java.util.List;
import java.util.Map;
import java.util.Set;

import org.hibernate.envers.tools.Pair;

/**
 * Queries that allow retrieving snapshots of all entities (regardless of their particular type) changed in the given
 * revision. Note that this API can be legally used only when default mechanism of tracking modified entity names
 * is enabled.
 *
 * @author Lukasz Antoniak (lukasz dot antoniak at gmail dot com)
 */
public interface CrossTypeRevisionChangesReader {
	/**
	 * Find all entities changed (added, updated and removed) in a given revision. Executes n+1 SQL queries,
	 * where n is a number of different entity classes modified within specified revision.
	 *
	 * @param revision Revision number.
	 *
	 * @return Snapshots of all audited entities changed in a given revision.
	 *
	 * @throws IllegalStateException If the associated entity manager is closed.
	 * @throws IllegalArgumentException If a revision number is null, less or equal to 0.
	 */
	public List findEntities(Number revision) throws IllegalStateException, IllegalArgumentException;

	/**
	 * Find all entities changed (added, updated or removed) in a given revision. Executes n+1 SQL queries,
	 * where n is a number of different entity classes modified within specified revision.
	 *
	 * @param revision Revision number.
	 * @param revisionType Type of modification.
	 *
	 * @return Snapshots of all audited entities changed in a given revision and filtered by modification type.
	 *
	 * @throws IllegalStateException If the associated entity manager is closed.
	 * @throws IllegalArgumentException If a revision number is {@code null}, less or equal to 0.
	 */
	public List findEntities(Number revision, RevisionType revisionType) throws IllegalStateException,
			IllegalArgumentException;

	/**
	 * Find all entities changed (added, updated and removed) in a given revision grouped by modification type.
	 * Executes mn+1 SQL queries, where:
	 * 
    *
  • n - number of different entity classes modified within specified revision. *
  • m - number of different revision types. See {@link RevisionType} enum. *
* * @param revision Revision number. * * @return Map containing lists of entity snapshots grouped by modification operation (e.g. addition, update, removal). * * @throws IllegalStateException If the associated entity manager is closed. * @throws IllegalArgumentException If a revision number is {@code null}, less or equal to 0. */ public Map> findEntitiesGroupByRevisionType(Number revision) throws IllegalStateException, IllegalArgumentException; /** * Returns set of entity names and corresponding Java classes modified in a given revision. * * @param revision Revision number. * * @return Set of entity names and corresponding Java classes modified in a given revision. * * @throws IllegalStateException If the associated entity manager is closed. * @throws IllegalArgumentException If a revision number is {@code null}, less or equal to 0. */ public Set> findEntityTypes(Number revision) throws IllegalStateException, IllegalArgumentException; }