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

   1 package org.onap.policy.api;
   2
   3 import java.util.Map;
   4
   5 import javax.json.JsonObject;
   6
   7 public interface DictionaryResponse {
   8
   9         /**
  10          * Gets the <code>String</code> of the DictionaryItemsMessage from <code>DictionaryResponse</code>.
  11          *
  12          * @return the <code>String</code> which consists of DictionaryItemsMessage from <code>DictionaryResponse</code>
  13          */
  14         public String getResponseMessage();
  15
  16         /**
  17          * Response code of type <code>Integer</code> which corresponds to the HTTP Response code explaining the response from Policy Engine.
  18          *
  19          * @return the responseCode in <code>Integer</code> format corresponding to the HTTP response code from Policy Engine.
  20          */
  21         public int getResponseCode();
  22
  23
  24         /**
  25          * Gets the <code>JsonObject</code> of all the Dictionary data retrieved
  26          *
  27          * @return the <code>JsonObject</code> which consists of Dictionary data which has been retrieved.
  28          */
  29         public JsonObject getDictionaryJson();
  30
  31
  32         /**
  33          * Gets the Key and Value pairs for each Dictionary item retrieved which can be used in the getDictionaryItems call.
  34          *
  35          * @return <code>Map</code> of <code>String, String</code> which consists of the Key and Value pairs for each Dictionary item retrieved.
  36          */
  37         public Map<String,String> getDictionaryData();
  38
  39
  40
  41 }