PolicyEngineAPI/src/main/java/org/onap/policy/api/DecisionResponse.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 /**
  24  * Defines the Object that represents the Policy Decision Response elements.
  25  * DecisionResponse communicates the decision and details
  26  *
  27  * @version 0.1
  28  */
  29 public interface DecisionResponse {
  30         /**
  31          * Gets the Decision of the Policy, Either a Permit or Deny.
  32          *
  33          * @return {@link org.onap.policy.api.PolicyDecision} Enumeration.
  34          */
  35         public PolicyDecision getDecision();
  36
  37         /**
  38          * Gets the details of the result. Would be required in case of Deny.
  39          *
  40          * @return <code>String</code> format of the details of Deny cause.
  41          */
  42         public String getDetails();
  43 }