2 * ============LICENSE_START=======================================================
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
11 * http://www.apache.org/licenses/LICENSE-2.0
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=========================================================
21 package org.onap.policy.api;
23 import com.fasterxml.jackson.annotation.JsonCreator;
26 * Enumeration of PolicyResponseStatus that can be returned as a part of
27 * {@link org.onap.policy.api.PolicyResponse}.
31 public enum PolicyResponseStatus {
33 * Indicates there is no action required.
35 NO_ACTION_REQUIRED("no_action"),
37 * Indicates that an action has been advised.
39 ACTION_ADVISED("action_advised"),
41 * Indicates that an action has been taken.
43 ACTION_TAKEN("action_taken");
45 private final String name;
47 private PolicyResponseStatus(final String name) {
52 * Get the <code>PolicyResponseStatus</code> based on <code>String</code>
53 * representation of <code>PolicyResponse</code>
55 * @param responseStatus
56 * the <code>String</code> Response Status
57 * @return the <code>PolicyResponseStatus</code> with the name matching
58 * <code>ACTION_ADVISED</code> or <code>ACTION_TAKEN</code> or
59 * <code>NO_ACTION_REQUIRED</code>
61 public static PolicyResponseStatus getStatus(final String responseStatus) {
62 if (ACTION_ADVISED.name.equalsIgnoreCase(responseStatus)) {
63 return ACTION_ADVISED;
64 } else if (ACTION_TAKEN.name.equalsIgnoreCase(responseStatus)) {
67 return NO_ACTION_REQUIRED;
72 * Returns the <code>String</code> name for this
73 * <code>PolicyResponseStatus</code>
75 * @return the <code>String</code> name for this
76 * <code>PolicyResponseStatus</code>
79 public String toString() {
84 public static PolicyResponseStatus create(final String value) {
85 for (final PolicyResponseStatus type : values()) {
86 if (type.toString().equalsIgnoreCase(value) || type.name().equalsIgnoreCase(value)) {
90 throw new IllegalArgumentException("Invalid value: " + value);