/******************************************************************************* | |
* Copyright (c) 1998, 2013 Oracle and/or its affiliates. All rights reserved. | |
* This program and the accompanying materials are made available under the | |
* terms of the Eclipse Public License v1.0 and Eclipse Distribution License v. 1.0 | |
* which accompanies this distribution. | |
* The Eclipse Public License is available at http://www.eclipse.org/legal/epl-v10.html | |
* and the Eclipse Distribution License is available at | |
* http://www.eclipse.org/org/documents/edl-v10.php. | |
* | |
* Contributors: | |
* Oracle - initial API and implementation from Oracle TopLink | |
******************************************************************************/ | |
package org.eclipse.persistence.sessions.changesets; | |
import java.util.*; | |
/** | |
* <p> | |
* <b>Purpose</b>: To Provide API to the UnitOfWorkChangeSet. | |
* <p> | |
* <b>Description</b>:The UnitOfWorkChangeSet contains all of the individual ObjectChangeSets. It is stored and used by the UnitOfWork | |
* <p> | |
*/ | |
public interface UnitOfWorkChangeSet { | |
/** | |
* ADVANCED: | |
* This method returns a reference to the collection. Not All ChangeSets that Exist in this list may have changes | |
* @return Map | |
*/ | |
public Map getAllChangeSets(); | |
/** | |
* ADVANCED: | |
* This method returns the reference to the deleted objects from the changeSet | |
* @return Map | |
*/ | |
public Map getDeletedObjects(); | |
/** | |
* ADVANCED: | |
* Get ChangeSet for a particular clone | |
* @return org.eclipse.persistence.sessions.changesets.ObjectChangeSet the changeSet that represents a particular clone | |
*/ | |
public ObjectChangeSet getObjectChangeSetForClone(Object clone); | |
/** | |
* ADVANCED: | |
* This method returns the Clone for a particular changeSet | |
* @return Object the clone represented by the changeSet | |
*/ | |
public Object getUOWCloneForObjectChangeSet(ObjectChangeSet changeSet); | |
/** | |
* ADVANCED: | |
* Returns true if the Unit Of Work change Set has changes | |
* @return boolean | |
*/ | |
public boolean hasChanges(); | |
} |