PolicyEngineUtils/src/main/java/org/onap/policy/api/LoadedPolicy.java

   1 /*-
   2  * ============LICENSE_START=======================================================
   3  * PolicyEngineUtils
   4  * ================================================================================
   5  * Copyright (C) 2017, 2019 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 /**
  26  * <code>LoadedPolicy</code> defines the Policy that has been Loaded into the PDP.
  27  *
  28  * @version 0.2
  29  */
  30 public interface LoadedPolicy {
  31
  32     /**
  33      * Gets the <code>String</code> format of the Policy Name that has been Loaded into the PDP.
  34      *
  35      * @return <code>String</code> format of Policy Name
  36      */
  37     String getPolicyName();
  38
  39     /**
  40      * Gets the <code>String</code> format of the Policy Version that has been Loaded into the PDP.
  41      *
  42      * @return <code>String</code> format of the Policy Version.
  43      */
  44     String getVersionNo();
  45
  46     /**
  47      * Gets the <code>Map</code> of <code>String,String</code> format of the Matches if the policy Loaded is of Config
  48      * Type.
  49      *
  50      * @return the <code>Map</code> of <code>String,String</code> format of the matches in the policy.
  51      */
  52     Map<String, String> getMatches();
  53
  54     /**
  55      * Gets the <code>UpdateType</code> of {@link org.onap.policy.api.UpdateType} received.
  56      *
  57      * @return <code>UpdateType</code> associated with this <code>PDPNotification</code>
  58      */
  59     UpdateType getUpdateType();
  60 }