PolicyEngineAPI/src/main/java/org/onap/policy/api/DictionaryResponse.java

   1 /*-
   2  * ============LICENSE_START=======================================================
   3  * PolicyEngineAPI
   4  * ================================================================================
   5  * Copyright (C) 2017 AT&T Intellectual Property. All rights reserved.
   6  * ================================================================================
   7  * Licensed under the Apache License, Version 2.0 (the "License");
   8  * you may not use this file except in compliance with the License.
   9  * You may obtain a copy of the License at
  10  *
  11  *      http://www.apache.org/licenses/LICENSE-2.0
  12  *
  13  * Unless required by applicable law or agreed to in writing, software
  14  * distributed under the License is distributed on an "AS IS" BASIS,
  15  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  16  * See the License for the specific language governing permissions and
  17  * limitations under the License.
  18  * ============LICENSE_END=========================================================
  19  */
  20
  21 package org.onap.policy.api;
  22
  23 import java.util.Map;
  24
  25 import javax.json.JsonObject;
  26
  27 public interface DictionaryResponse {
  28
  29         /**
  30          * Gets the <code>String</code> of the DictionaryItemsMessage from <code>DictionaryResponse</code>.
  31          *
  32          * @return the <code>String</code> which consists of DictionaryItemsMessage from <code>DictionaryResponse</code>
  33          */
  34         public String getResponseMessage();
  35
  36         /**
  37          * Response code of type <code>Integer</code> which corresponds to the HTTP Response code explaining the response from Policy Engine.
  38          *
  39          * @return the responseCode in <code>Integer</code> format corresponding to the HTTP response code from Policy Engine.
  40          */
  41         public int getResponseCode();
  42
  43
  44         /**
  45          * Gets the <code>JsonObject</code> of all the Dictionary data retrieved
  46          *
  47          * @return the <code>JsonObject</code> which consists of Dictionary data which has been retrieved.
  48          */
  49         public JsonObject getDictionaryJson();
  50
  51
  52         /**
  53          * Gets the Key and Value pairs for each Dictionary item retrieved which can be used in the getDictionaryItems call.
  54          *
  55          * @return <code>Map</code> of <code>String, String</code> which consists of the Key and Value pairs for each Dictionary item retrieved.
  56          */
  57         public Map<String,String> getDictionaryData();
  58
  59
  60
  61 }