summaryrefslogtreecommitdiffstats
path: root/appc-lifecycle-management/state-machine-lib/src/main/java/org/openecomp/appc/statemachine/StateMachine.java
blob: 52350852ef5d4b926e1abfd838fc495b779bbee4 (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
/*-
 * ============LICENSE_START=======================================================
 * ONAP : APPC
 * ================================================================================
 * Copyright (C) 2017 AT&T Intellectual Property. All rights reserved.
 * ================================================================================
 * Copyright (C) 2017 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.
 * 
 * ECOMP is a trademark and service mark of AT&T Intellectual Property.
 * ============LICENSE_END=========================================================
 */

package org.onap.appc.statemachine;

import org.onap.appc.exceptions.InvalidInputException;
import org.onap.appc.statemachine.objects.Event;
import org.onap.appc.statemachine.objects.State;
import org.onap.appc.statemachine.objects.StateMachineResponse;

/**
 * Interface of the StateMachine
 */
public interface StateMachine {
    /**
     * Handle event
     * @param currentState the current State which the event should be handled from
     * @param event the Event that needs to be handled
     * @return StateMachineResponse
     * @throws InvalidInputException
     *     when the passed in currentState and event are not predefined or no relevant transition
     */
    StateMachineResponse handleEvent(State currentState, Event event) throws InvalidInputException;
}