dcae-analytics/dcae-analytics-tca-core/src/main/java/org/onap/dcae/analytics/tca/core/service/TcaProcessingContext.java

   1 /*
   2  * ================================================================================
   3  * Copyright (c) 2018 AT&T Intellectual Property. All rights reserved.
   4  * ================================================================================
   5  * Licensed under the Apache License, Version 2.0 (the "License");
   6  * you may not use this file except in compliance with the License.
   7  * You may obtain a copy of the License at
   8  *
   9  *      http://www.apache.org/licenses/LICENSE-2.0
  10  *
  11  * Unless required by applicable law or agreed to in writing, software
  12  * distributed under the License is distributed on an "AS IS" BASIS,
  13  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  14  * See the License for the specific language governing permissions and
  15  * limitations under the License.
  16  * ============LICENSE_END=========================================================
  17  *
  18  */
  19
  20 package org.onap.dcae.analytics.tca.core.service;
  21
  22 import org.onap.dcae.analytics.model.cef.EventListener;
  23
  24 /**
  25  * TCA Processing Context captures various mutable fields that are computed during TCA execution
  26  *
  27  * @author Rajiv Singla
  28  */
  29 public interface TcaProcessingContext {
  30
  31
  32     /**
  33      * Provides common event format message as JAVA object that is being analyzed
  34      *
  35      * @return common event format message as JAVA object that is being analyzed
  36      */
  37     EventListener getEventListener();
  38
  39
  40     /**
  41      * Sets new values for common event format message as JAVA object that is being analyzed
  42      *
  43      * @param eventListener new values for common event format message as JAVA object that is being analyzed
  44      */
  45     void setEventListener(EventListener eventListener);
  46
  47
  48     /**
  49      * Provides flag which is false if TCA processing cannot continue to next stage due to some prior condition
  50      *
  51      * @return false if TCA processing cannot continue to next stage due to some condition
  52      */
  53     boolean isContinueProcessing();
  54
  55     /**
  56      * Sets TCA processing continue flag
  57      *
  58      * @param isContinueProcessing - TCA processing continue flag
  59      */
  60     void setContinueProcessing(boolean isContinueProcessing);
  61
  62
  63     /**
  64      * Provides early termination message message if present or null
  65      *
  66      * @return early termination message if present or null
  67      */
  68     String getEarlyTerminationMessage();
  69
  70     /**
  71      * Sets early termination message
  72      *
  73      * @param earlyTerminationMessage sets a new value for early termination message
  74      */
  75     void setEarlyTerminationMessage(String earlyTerminationMessage);
  76
  77
  78     /**
  79      * Returns error message if present or null
  80      *
  81      * @return error message if present or null
  82      */
  83     String getErrorMessage();
  84
  85     /**
  86      * Sets new value for error message
  87      *
  88      * @param errorMessage new value for error message
  89      */
  90     void setErrorMessage(final String errorMessage);
  91
  92 }