Update project structure to org.onap

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

diff --git a/datarouter-prov/src/main/java/org/onap/dmaap/datarouter/provisioning/beans/Syncable.java b/datarouter-prov/src/main/java/org/onap/dmaap/datarouter/provisioning/beans/Syncable.java
new file mode 100644 (file)
index 0000000..8e6b9c9
--- /dev/null
+++ b/datarouter-prov/src/main/java/org/onap/dmaap/datarouter/provisioning/beans/Syncable.java
@@ -0,0 +1,57 @@
+/*******************************************************************************\r
+ * ============LICENSE_START==================================================\r
+ * * org.onap.dmaap\r
+ * * ===========================================================================\r
+ * * Copyright © 2017 AT&T Intellectual Property. All rights reserved.\r
+ * * ===========================================================================\r
+ * * Licensed under the Apache License, Version 2.0 (the "License");\r
+ * * you may not use this file except in compliance with the License.\r
+ * * You may obtain a copy of the License at\r
+ * * \r
+ *  *      http://www.apache.org/licenses/LICENSE-2.0\r
+ * * \r
+ *  * Unless required by applicable law or agreed to in writing, software\r
+ * * distributed under the License is distributed on an "AS IS" BASIS,\r
+ * * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\r
+ * * See the License for the specific language governing permissions and\r
+ * * limitations under the License.\r
+ * * ============LICENSE_END====================================================\r
+ * *\r
+ * * ECOMP is a trademark and service mark of AT&T Intellectual Property.\r
+ * *\r
+ ******************************************************************************/\r
+\r
+\r
+package org.onap.dmaap.datarouter.provisioning.beans;\r
+\r
+import java.sql.Connection;\r
+\r
+import org.json.JSONObject;\r
+\r
+/**\r
+ * This abstract class defines the "contract" for beans that can be sync-ed with the database,\r
+ * by means of straight comparison.  The <i>getKey</i> method is used to return the primary key\r
+ * used to identify a record.\r
+ *\r
+ * @author Robert Eby\r
+ * @version $Id: Syncable.java,v 1.1 2013/07/05 13:48:05 eby Exp $\r
+ */\r
+public abstract class Syncable implements Deleteable, Insertable, Updateable, JSONable {\r
+       @Override\r
+       abstract public JSONObject asJSONObject();\r
+\r
+       @Override\r
+       abstract public boolean doUpdate(Connection c);\r
+\r
+       @Override\r
+       abstract public boolean doInsert(Connection c);\r
+\r
+       @Override\r
+       abstract public boolean doDelete(Connection c);\r
+\r
+       /**\r
+        * Get the "natural key" for this object type, as a String.\r
+        * @return the key\r
+        */\r
+       abstract public String getKey();\r
+}\r