PolicyEngineAPI/src/main/java/org/openecomp/policy/api/PolicyChangeResponse.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.openecomp.policy.api;
  22
  23 /**
  24  * <code>PolicyChangeResponse</code> defines the Policy Response
  25  *  which is Contains responseCode corresponding to HTTP response Codes with response Message.
  26  *
  27  * @version 0.1
  28  */
  29 public interface PolicyChangeResponse {
  30
  31         /**
  32          * Policy Change Response Message in <code>String</code> format from the Policy Engine.
  33          *
  34          * @return the responseMessage in <code>String</code> format related to Response from Policy Engine.
  35          */
  36         public String getResponseMessage();
  37
  38         /**
  39          * Response code of type <code>Integer</code> which corresponds to the HTTP Response code explaining the response from Policy Engine.
  40          *
  41          * @return the responseCode in <code>Integer</code> format corresponding to the HTTP response code from Policy Engine.
  42          */
  43         public int getResponseCode();
  44 }