View Javadoc
1 package org.apache.torque.om; 2 3 /* ==================================================================== 4 * The Apache Software License, Version 1.1 5 * 6 * Copyright (c) 2001 The Apache Software Foundation. All rights 7 * reserved. 8 * 9 * Redistribution and use in source and binary forms, with or without 10 * modification, are permitted provided that the following conditions 11 * are met: 12 * 13 * 1. Redistributions of source code must retain the above copyright 14 * notice, this list of conditions and the following disclaimer. 15 * 16 * 2. Redistributions in binary form must reproduce the above copyright 17 * notice, this list of conditions and the following disclaimer in 18 * the documentation and/or other materials provided with the 19 * distribution. 20 * 21 * 3. The end-user documentation included with the redistribution, 22 * if any, must include the following acknowledgment: 23 * "This product includes software developed by the 24 * Apache Software Foundation (http://www.apache.org/)." 25 * Alternately, this acknowledgment may appear in the software itself, 26 * if and wherever such third-party acknowledgments normally appear. 27 * 28 * 4. The names "Apache" and "Apache Software Foundation" and 29 * "Apache Turbine" must not be used to endorse or promote products 30 * derived from this software without prior written permission. For 31 * written permission, please contact apache@apache.org. 32 * 33 * 5. Products derived from this software may not be called "Apache", 34 * "Apache Turbine", nor may "Apache" appear in their name, without 35 * prior written permission of the Apache Software Foundation. 36 * 37 * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED 38 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES 39 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE 40 * DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR 41 * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 42 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 43 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF 44 * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND 45 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, 46 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT 47 * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 48 * SUCH DAMAGE. 49 * ==================================================================== 50 * 51 * This software consists of voluntary contributions made by many 52 * individuals on behalf of the Apache Software Foundation. For more 53 * information on the Apache Software Foundation, please see 54 * <http://www.apache.org/>. 55 */ 56 57 import java.sql.Connection; 58 59 /*** 60 * This interface defines methods related to saving an object 61 * 62 * @author <a href="mailto:jmcnally@collab.net">John D. McNally</a> 63 * @author <a href="mailto:fedor@apache.org">Fedor K.</a> 64 * @version $Id: Persistent.java,v 1.11 2002/12/29 18:17:26 mpoeschl Exp $ 65 */ 66 public interface Persistent 67 { 68 /*** 69 * getter for the object primaryKey. 70 * 71 * @return the object primaryKey as an Object 72 */ 73 ObjectKey getPrimaryKey(); 74 75 /*** 76 * Sets the PrimaryKey for the object. 77 * 78 * @param primaryKey The new PrimaryKey for the object. 79 * @throws Exception This method might throw an exception 80 */ 81 void setPrimaryKey(ObjectKey primaryKey) throws Exception; 82 83 /*** 84 * Sets the PrimaryKey for the object. 85 * 86 * @param primaryKey the String should be of the form produced by 87 * ObjectKey.toString(). 88 * @throws Exception This method might throw an exception 89 */ 90 void setPrimaryKey(String primaryKey) throws Exception; 91 92 /*** 93 * Returns whether the object has been modified, since it was 94 * last retrieved from storage. 95 * 96 * @return True if the object has been modified. 97 */ 98 boolean isModified(); 99 100 /*** 101 * Returns whether the object has ever been saved. This will 102 * be false, if the object was retrieved from storage or was created 103 * and then saved. 104 * 105 * @return true, if the object has never been persisted. 106 */ 107 boolean isNew(); 108 109 /*** 110 * Setter for the isNew attribute. This method will be called 111 * by Torque-generated children and Peers. 112 * 113 * @param b the state of the object. 114 */ 115 void setNew(boolean b); 116 117 /*** 118 * Sets the modified state for the object. 119 * 120 * @param m The new modified state for the object. 121 */ 122 void setModified(boolean m); 123 124 /*** 125 * Saves the object. 126 * 127 * @throws Exception This method might throw an exception 128 */ 129 void save() throws Exception; 130 131 /*** 132 * Stores the object in the database. If the object is new, 133 * it inserts it; otherwise an update is performed. 134 * 135 * @param dbName the name of the database 136 * @throws Exception This method might throw an exception 137 */ 138 void save(String dbName) throws Exception; 139 140 /*** 141 * Stores the object in the database. If the object is new, 142 * it inserts it; otherwise an update is performed. This method 143 * is meant to be used as part of a transaction, otherwise use 144 * the save() method and the connection details will be handled 145 * internally 146 * 147 * @param con the Connection used to store the object 148 * @throws Exception This method might throw an exception 149 */ 150 void save(Connection con) throws Exception; 151 }

This page was automatically generated by Maven