PolicyEngineAPI/src/main/java/org/openecomp/policy/api/PolicyResponseStatus.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  * Enumeration of PolicyResponseStatus that can be returned as a part of
  25  * {@link org.openecomp.policy.api.PolicyResponse}.
  26  *
  27  * @version 0.2
  28  */
  29 public enum PolicyResponseStatus {
  30         /**
  31          * Indicates there is no action required.
  32          */
  33         NO_ACTION_REQUIRED("no_action"),
  34         /**
  35          * Indicates that an action has been advised.
  36          */
  37         ACTION_ADVISED("action_advised"),
  38         /**
  39          * Indicates that an action has been taken.
  40          */
  41         ACTION_TAKEN("action_taken")
  42         ;
  43
  44         private String name;
  45         private PolicyResponseStatus(String name){
  46                 this.name = name;
  47         }
  48
  49         /**
  50          * Get the <code>PolicyResponseStatus</code> based on <code>String</code> representation of <code>PolicyResponse</code>
  51          *
  52          * @param responseStatus the <code>String</code> Response Status
  53          * @return the <code>PolicyResponseStatus</code> with the name matching <code>ACTION_ADVISED</code> or <code>ACTION_TAKEN</code> or <code>NO_ACTION_REQUIRED</code>
  54          */
  55         public static PolicyResponseStatus getStatus(String responseStatus) {
  56                 if(responseStatus.equalsIgnoreCase("action_advised")) {
  57                         return ACTION_ADVISED;
  58                 }else if(responseStatus.equalsIgnoreCase("action_taken")) {
  59                         return ACTION_TAKEN;
  60                 }else {
  61                         return NO_ACTION_REQUIRED;
  62                 }
  63         }
  64
  65         /**
  66          * Returns the <code>String</code> name for this <code>PolicyResponseStatus</code>
  67          *
  68          * @return the <code>String</code> name for this <code>PolicyResponseStatus</code>
  69          */
  70         public String toString(){
  71                 return this.name;
  72         }
  73 }