Initial OpenECOMP policy/engine commit
[policy/engine.git] / PolicyEngineAPI / src / main / java / org / openecomp / policy / api / PolicyDecision.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 PolicyDecision that can be returned as a part of 
25  * {@link org.openecomp.policy.api.DecisionResponse} getDecision().
26  * 
27  * @version 0.1
28  */
29 public enum PolicyDecision {
30         /**
31          * Indicates that the Decision is to Permit. 
32          */
33         PERMIT("permit"),
34         /**
35          * Indicates that the Decision is to Deny. 
36          */
37         DENY("deny"),
38         /**
39          * Indicates that the Decision process has some issues. 
40          */
41         ERROR("error")
42         ;
43         
44         private String name;
45         private PolicyDecision(String name){
46                 this.name = name;
47         }
48         
49         /**
50          * Returns the <code>String</code> name for this <code>PolicyDecision</code>
51          * 
52          * @return the <code>String</code> name for this <code>PolicyDecision</code>
53          */
54         public String toString(){
55                 return this.name;
56         }
57 }