summaryrefslogtreecommitdiffstats
path: root/src/main/java/org/onap/aai/validation/ruledriven/rule/Rule.java
blob: 60705ea182aa384683fdce9e86e917968ac74810 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
/*
 * ============LICENSE_START===================================================
 * Copyright (c) 2018 Amdocs
 * ============================================================================
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *        http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 * ============LICENSE_END=====================================================
 */
package org.onap.aai.validation.ruledriven.rule;

import java.util.List;
import org.onap.aai.validation.reader.data.AttributeValues;

/**
 * A rule that accepts one or more attributes and returns a Boolean result (when executed)
 */
public interface Rule {

    /**
     * Gets the name of the rule
     *
     * @return the name
     */
    String getName();

    /**
     * Gets the error message.
     *
     * @return the error message
     */
    String getErrorMessage();

    /**
     * Gets the error category.
     *
     * @return the error category
     */
    String getErrorCategory();

    /**
     * Gets the severity.
     *
     * @return the severity
     */
    String getSeverity();

    /**
     * Gets the paths to the attributes to pass to the rule
     *
     * @return the attribute paths
     */
    List<String> getAttributePaths();

    /**
     * Execute the rule.
     *
     * @param values
     *            the attribute values to pass to the rule
     * @return a RuleResult instance representing the rule evaluation (meaning success/failure)
     */
    RuleResult execute(AttributeValues values);

    /**
     * Execute the rule.
     *
     * @param values
     *            the attribute values to pass to the rule
     * @return a RuleResult instance representing the rule evaluation (meaning success/failure)
     */
    RuleResult execute(Object... values);

}