authz-cass/src/main/java/org/onap/aaf/dao/DAO_RO.java

   1 /*******************************************************************************\r
   2  * ============LICENSE_START====================================================\r
   3  * * org.onap.aaf\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 package org.onap.aaf.dao;\r
  24 \r
  25 import java.util.List;\r
  26 \r
  27 import org.onap.aaf.authz.layer.Result;\r
  28 \r
  29 import org.onap.aaf.inno.env.Trans;\r
  30 \r
  31 /**\r
  32  * DataAccessObject - ReadOnly\r
  33  * \r
  34  * It is useful to have a ReadOnly part of the interface for CachedDAO\r
  35  * \r
  36  * Normal DAOs will implement full DAO\r
  37  * \r
  38  *\r
  39  * @param <DATA>\r
  40  */\r
  41 public interface DAO_RO<TRANS extends Trans,DATA> {\r
  42         /**\r
  43          * Get a List of Data given Key of Object Array\r
  44          * @param objs\r
  45          * @return\r
  46          * @throws DAOException\r
  47          */\r
  48         public Result<List<DATA>> read(TRANS trans, Object ... key);\r
  49 \r
  50         /**\r
  51          * Get a List of Data given Key of DATA Object\r
  52          * @param trans\r
  53          * @param key\r
  54          * @return\r
  55          * @throws DAOException\r
  56          */\r
  57         public Result<List<DATA>> read(TRANS trans, DATA key);\r
  58 \r
  59         /**\r
  60          * close DAO\r
  61          */\r
  62         public void close(TRANS trans);\r
  63 \r
  64         /**\r
  65          * Return name of referenced Data\r
  66          * @return\r
  67          */\r
  68         public String table();\r
  69 \r
  70 \r
  71 }\r