Update project structure to org.onap.aaf
[aaf/authz.git] / authz-cass / src / main / java / org / onap / aaf / dao / DAO_RO.java
diff --git a/authz-cass/src/main/java/org/onap/aaf/dao/DAO_RO.java b/authz-cass/src/main/java/org/onap/aaf/dao/DAO_RO.java
new file mode 100644 (file)
index 0000000..a853675
--- /dev/null
@@ -0,0 +1,71 @@
+/*******************************************************************************\r
+ * ============LICENSE_START====================================================\r
+ * * org.onap.aaf\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
+package org.onap.aaf.dao;\r
+\r
+import java.util.List;\r
+\r
+import org.onap.aaf.authz.layer.Result;\r
+\r
+import org.onap.aaf.inno.env.Trans;\r
+\r
+/**\r
+ * DataAccessObject - ReadOnly\r
+ * \r
+ * It is useful to have a ReadOnly part of the interface for CachedDAO\r
+ * \r
+ * Normal DAOs will implement full DAO\r
+ * \r
+ *\r
+ * @param <DATA>\r
+ */\r
+public interface DAO_RO<TRANS extends Trans,DATA> {\r
+       /**\r
+        * Get a List of Data given Key of Object Array\r
+        * @param objs\r
+        * @return\r
+        * @throws DAOException\r
+        */\r
+       public Result<List<DATA>> read(TRANS trans, Object ... key);\r
+\r
+       /**\r
+        * Get a List of Data given Key of DATA Object\r
+        * @param trans\r
+        * @param key\r
+        * @return\r
+        * @throws DAOException\r
+        */\r
+       public Result<List<DATA>> read(TRANS trans, DATA key);\r
+\r
+       /**\r
+        * close DAO\r
+        */\r
+       public void close(TRANS trans);\r
+\r
+       /**\r
+        * Return name of referenced Data\r
+        * @return\r
+        */\r
+       public String table();\r
+\r
+\r
+}\r