datarouter-prov/src/main/java/org/onap/dmaap/datarouter/provisioning/beans/Syncable.java

   1 /*******************************************************************************\r
   2  * ============LICENSE_START==================================================\r
   3  * * org.onap.dmaap\r
   4  * * ===========================================================================\r
   5  * * Copyright © 2017 AT&T Intellectual Property. All rights reserved.\r
   6  * * ===========================================================================\r
   7  * * Licensed under the Apache License, Version 2.0 (the "License");\r
   8  * * you may not use this file except in compliance with the License.\r
   9  * * You may obtain a copy of the License at\r
  10  * *\r
  11  *  *      http://www.apache.org/licenses/LICENSE-2.0\r
  12  * *\r
  13  *  * Unless required by applicable law or agreed to in writing, software\r
  14  * * distributed under the License is distributed on an "AS IS" BASIS,\r
  15  * * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\r
  16  * * See the License for the specific language governing permissions and\r
  17  * * limitations under the License.\r
  18  * * ============LICENSE_END====================================================\r
  19  * *\r
  20  * * ECOMP is a trademark and service mark of AT&T Intellectual Property.\r
  21  * *\r
  22  ******************************************************************************/\r
  23 \r
  24 \r
  25 package org.onap.dmaap.datarouter.provisioning.beans;\r
  26 \r
  27 import java.sql.Connection;\r
  28 \r
  29 import org.json.JSONObject;\r
  30 \r
  31 /**\r
  32  * This abstract class defines the "contract" for beans that can be sync-ed with the database,\r
  33  * by means of straight comparison.  The <i>getKey</i> method is used to return the primary key\r
  34  * used to identify a record.\r
  35  *\r
  36  * @author Robert Eby\r
  37  * @version $Id: Syncable.java,v 1.1 2013/07/05 13:48:05 eby Exp $\r
  38  */\r
  39 \r
  40 public abstract class Syncable implements Deleteable, Insertable, Updateable, JSONable {\r
  41     @Override\r
  42     public abstract JSONObject asJSONObject();\r
  43 \r
  44     @Override\r
  45     public abstract boolean doUpdate(Connection conn);\r
  46 \r
  47     @Override\r
  48     public abstract boolean doInsert(Connection conn);\r
  49 \r
  50     @Override\r
  51     public abstract boolean doDelete(Connection conn);\r
  52 \r
  53     /**\r
  54      * Get the "natural key" for this object type, as a String.\r
  55      *\r
  56      * @return the key\r
  57      */\r
  58     public abstract String getKey();\r
  59 }\r