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