PolicyEngineAPI/src/main/java/org/openecomp/policy/api/PolicyConfigStatus.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 PolicyConfigStatus that can be returned as a part of
  25  * {@link org.openecomp.policy.api.PolicyConfig}.
  26  *
  27  * @version 0.1
  28  */
  29 public enum PolicyConfigStatus {
  30         /**
  31          * Indicates that the Configuration has been successfully retrieved.
  32          */
  33         CONFIG_RETRIEVED("retrieved"),
  34         /**
  35          * Indicates that there is no Configuration Retrieved from PolicyConfig.
  36          */
  37         CONFIG_NOT_FOUND("not_found"),
  38         ;
  39
  40         private String name;
  41         private PolicyConfigStatus(String name){
  42                 this.name = name;
  43         }
  44
  45         /**
  46          * Get the <code>PolicyConfigStatus</code> based on <code>String</code> representation of <code>PolicyConfig</code>
  47          *
  48          * @param configStatus the <code>String</code> Configuration Status
  49          * @return the <code>PolicyConfigResponse</code> with the name matching <code>CONFIG_RETRIEVED</code> or <code>CONFIG_NOT_FOUND</code>
  50          * if no match is found
  51          */
  52         public static PolicyConfigStatus getStatus(String configStatus) {
  53                 if(configStatus.equalsIgnoreCase("retrieved")) {
  54                         return CONFIG_RETRIEVED;
  55                 }else {
  56                         return CONFIG_NOT_FOUND;
  57                 }
  58         }
  59
  60         /**
  61          * Returns the <code>String</code> name for this <code>PolicyConfigStatus</code>
  62          *
  63          * @return the <code>String</code> name for this <code>PolicyConfigStatus</code>
  64          */
  65         public String toString(){
  66                 return this.name;
  67         }
  68 }