PolicyEngineAPI/src/main/java/org/onap/policy/api/PushPolicyParameters.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.UUID;
  24
  25 /**
  26  * <code>PushPolicyParameters</code> defines the Policy Parameters
  27  *  which are required to Push a Policy to PDPGroup.
  28  *
  29  * @version 0.1
  30  */
  31 public class PushPolicyParameters {
  32         private String policyName;
  33         private String policyType;
  34         private String pdpGroup;
  35         private UUID requestID;
  36
  37         /**
  38          * Constructor with no Parameters.
  39          */
  40         public PushPolicyParameters(){
  41         }
  42
  43         /**
  44          * Constructor with Parameters.
  45          *
  46          * @param policyName the <code>String</code> format of the Policy Name
  47          * @param policyType the <code>String</code> format of the Policy Type
  48          * @param pdpGroup the <code>String</code> format of the PDPGroup
  49          * @param requestID unique request ID which will be passed throughout the ONAP components to correlate logging messages.
  50          */
  51         public PushPolicyParameters(String policyName, String policyType, String pdpGroup, UUID requestID){
  52                 this.policyName = policyName;
  53                 this.policyType = policyType;
  54                 this.pdpGroup = pdpGroup;
  55                 this.requestID = requestID;
  56         }
  57
  58         /**
  59          * Gets the PolicyName of the Push Policy Parameters.
  60          *
  61          * @return policyName the <code>String</code> format of the Policy Name
  62          */
  63         public String getPolicyName() {
  64                 return policyName;
  65         }
  66
  67         /**
  68          * Sets the policyName of the Push Policy Parameters.
  69          *
  70          * @param policyName the <code>String</code> format of the Policy Name
  71          */
  72         public void setPolicyName(String policyName) {
  73                 this.policyName = policyName;
  74         }
  75
  76         /**
  77          * Gets the PolicyType of the Push Policy Parameters.
  78          *
  79          * @return policyType the <code>String</code> format of the Policy Type
  80          */
  81         public String getPolicyType() {
  82                 return policyType;
  83         }
  84
  85         /**
  86          * Sets the policyType of the Push Policy Parameters.
  87          *
  88          * @param policyType the <code>String</code> format of the Policy Type
  89          */
  90         public void setPolicyType(String policyType) {
  91                 this.policyType = policyType;
  92         }
  93
  94         /**
  95          * Gets the PDPGroup of the Push Policy Parameters.
  96          *
  97          * @return pdpGroup the <code>String</code> format of the PDPGroup
  98          */
  99         public String getPdpGroup() {
 100                 return pdpGroup;
 101         }
 102
 103         /**
 104          * Sets the PDPGroup of the Push Policy Parameters.
 105          *
 106          * @param pdpGroup the <code>String</code> format of the PDPGroup
 107          */
 108         public void setPdpGroup(String pdpGroup) {
 109                 this.pdpGroup = pdpGroup;
 110         }
 111
 112         /**
 113          * Gets the requestID of the Push Policy Parameters.
 114          *
 115          * @return unique request ID which will be passed throughout the ONAP components to correlate logging messages.
 116          */
 117         public UUID getRequestID() {
 118                 return requestID;
 119         }
 120
 121         /**
 122          * Sets the requestID of the Push Policy Parameters.
 123          *
 124          * @param requestID unique request ID which will be passed throughout the ONAP components to correlate logging messages.
 125          */
 126         public void setRequestID(UUID requestID) {
 127                 this.requestID = requestID;
 128         }
 129
 130
 131 }