summaryrefslogtreecommitdiffstats
path: root/dcae-analytics/dcae-analytics-tca-core/src/main/java/org/onap/dcae/analytics/tca/core/service/TcaAbatementContext.java
blob: 9ec419215c3ad1d98856bd65dc4a4d8448ebddea (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
/*
 * ================================================================================
 * 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;

/**
 * Provides abstractions for TCA Abatement processing calculations
 *
 * @author Rajiv Singla
 */
public interface TcaAbatementContext {

    /**
     * Returns true if TCA Abatement calculations are enabled
     *
     * @return true if TCA Abatement calculations are enabled
     */
    boolean isAbatementEnabled();


    /**
     * Provides abstractions for Tca Abatement Persistence
     *
     * @return abstractions for Tca Abatement Persistence
     */
    TcaAbatementRepository getTcaAbatementRepository();


    /**
     * Creates new instance of TCA Abatement persistence Entity
     *
     * @param lookupKey lookup key
     * @param requestId request id
     * @param isAbatementAlertSent true if abatement alert was already sent
     *
     * @return new instance of TCA Abatement Persistence Entity
     */
    TcaAbatementEntity create(String lookupKey, String requestId, boolean isAbatementAlertSent);


}