gerrit.onap Code Review - policy/clamp.git/blob

   1 /*-
   2  * ============LICENSE_START=======================================================
   3  * Copyright (C) 2021 Nordix Foundation.
   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  *
  17  * SPDX-License-Identifier: Apache-2.0
  18  * ============LICENSE_END=========================================================
  19  */
  20
  21 package org.onap.policy.clamp.controlloop.models.controlloop.concepts;
  22
  23 /**
  24  * Class to hold the possible values for mode of participant.
  25  */
  26 public enum ParticipantState {
  27
  28     /**
  29      * Control Loop execution is unknown.
  30      */
  31     UNKNOWN,
  32
  33     /**
  34      * Control Loop execution is always rejected.
  35      */
  36     PASSIVE,
  37
  38     /**
  39      * Control Loop execution execution proceeds, but changes to domain state or context are not carried out. The
  40      * participant returns an indication that it is running in SAFE mode together with the action it would have
  41      * performed if it was operating in ACTIVE mode.
  42      */
  43     SAFE,
  44
  45     /**
  46      * Control Loop execution execution proceeds and changes to domain and state are carried out in a test environment.
  47      * The participant returns an indication that it is running in TEST mode together with the action it has performed
  48      * on the test environment.
  49      */
  50     TEST,
  51
  52     /**
  53      * Control Loop execution execution is executed in the live environment by the participant.
  54      */
  55     ACTIVE,
  56
  57     /**
  58      * Control Loop execution execution is terminated and not available.
  59      */
  60     TERMINATED
  61 }