oracle.toplink.essentials.changesets.UnitOfWorkChangeSet Maven / Gradle / Ivy
/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* // Copyright (c) 1998, 2007, Oracle. All rights reserved.
*
*
* The contents of this file are subject to the terms of either the GNU
* General Public License Version 2 only ("GPL") or the Common Development
* and Distribution License("CDDL") (collectively, the "License"). You
* may not use this file except in compliance with the License. You can obtain
* a copy of the License at https://glassfish.dev.java.net/public/CDDL+GPL.html
* or glassfish/bootstrap/legal/LICENSE.txt. See the License for the specific
* language governing permissions and limitations under the License.
*
* When distributing the software, include this License Header Notice in each
* file and include the License file at glassfish/bootstrap/legal/LICENSE.txt.
* Sun designates this particular file as subject to the "Classpath" exception
* as provided by Sun in the GPL Version 2 section of the License file that
* accompanied this code. If applicable, add the following below the License
* Header, with the fields enclosed by brackets [] replaced by your own
* identifying information: "Portions Copyrighted [year]
* [name of copyright owner]"
*
* Contributor(s):
*
* If you wish your version of this file to be governed by only the CDDL or
* only the GPL Version 2, indicate your decision by adding "[Contributor]
* elects to include this software in this distribution under the [CDDL or GPL
* Version 2] license." If you don't indicate a single choice of license, a
* recipient has the option to distribute your version of this file under
* either the CDDL, the GPL Version 2 or to extend the choice of license to
* its licensees as provided above. However, if you add GPL Version 2 code
* and therefore, elected the GPL Version 2 license, then the option applies
* only if the new code is made subject to such option by the copyright
* holder.
*/
package oracle.toplink.essentials.changesets;
/**
*
* Purpose: To Provide API to the UnitOfWorkChangeSet.
*
* Description:The UnitOfWorkChangeSet contains all of the individual ObjectChangeSets. It is stored and used by the UnitOfWork
*
*/
public interface UnitOfWorkChangeSet {
/**
* ADVANCED:
* This method returns a reference to the collection. Not All ChangeSets that Exist in this list may have changes
* @return oracle.toplink.essentials.internal.helper.IdentityHashtable
*/
public oracle.toplink.essentials.internal.helper.IdentityHashtable getAllChangeSets();
/**
* ADVANCED:
* This method returns the reference to the deleted objects from the changeSet
* @return oracle.toplink.essentials.internal.helper.IdentityHashtable
*/
public oracle.toplink.essentials.internal.helper.IdentityHashtable getDeletedObjects();
/**
* ADVANCED:
* Get ChangeSet for a particular clone
* @return oracle.toplink.essentials.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();
}