summaryrefslogtreecommitdiffstats
path: root/dcae-analytics/dcae-analytics-tca-core/src/main/java/org/onap/dcae/analytics/tca/core/service/TcaResultContext.java
blob: b166a5f3c658cb5d6be02850586cd1ef72dfa7c1 (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
82
83
84
85
86
87
88
/*
 * ================================================================================
 * Copyright (c) 2018 AT&T Intellectual Property. All rights reserved.
 * ================================================================================
 * 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.dcae.analytics.tca.core.service;

import org.onap.dcae.analytics.tca.model.facade.TcaAlert;
import org.onap.dcae.analytics.tca.model.policy.MetricsPerEventName;

/**
 * TCA Processing Result Context which captures outputs of TCA Execution
 *
 * @author Rajiv Singla
 */
public interface TcaResultContext {

    /**
     * Returns true if Threshold violations are present
     *
     * @return true if Threshold violations are present
     */
    boolean isThresholdViolationsPresent();


    /**
     * Returns TCA policy's violated metrics per event name that was violated by the incoming message
     *
     * @return TCA policy's violated metrics per event name that was violated by the incoming message
     */
    MetricsPerEventName getViolatedMetricsPerEventName();


    /**
     * Sets new value for violated metrics per event name that was violated by the incoming message
     *
     * @param violatedMetricsPerEventName new value for violated metrics per event name that was violated by the
     * incoming message
     */
    void setViolatedMetricsPerEventName(MetricsPerEventName violatedMetricsPerEventName);


    /**
     * Provides TCA Alert message that is generated if there is any TCA policy's threshold violation
     *
     * @return TCA Alert message that is generated if there is any TCA policy's threshold violation
     */
    TcaAlert getTcaAlert();


    /**
     * Sets new value for TCA Alert
     *
     * @param tcaAlert new value for TCA Alert
     */
    void setTcaAlert(TcaAlert tcaAlert);

    /**
     * Provides previous request id for abated threshold violations if present or null
     *
     * @return previous request id for abated threshold violations if present or null
     */
    String getPreviousRequestId();


    /**
     * Sets previous request id for abated threshold violations
     *
     * @param previousRequestId new value of request id for abated threshold violations
     */
    void setPreviousRequestId(String previousRequestId);


}