Classes in this File | Line Coverage | Branch Coverage | Complexity | ||||
Transition |
|
| 1.0;1 |
1 | /* | |
2 | * Licensed to the Apache Software Foundation (ASF) under one or more | |
3 | * contributor license agreements. See the NOTICE file distributed with | |
4 | * this work for additional information regarding copyright ownership. | |
5 | * The ASF licenses this file to you under the Apache License, Version 2.0 | |
6 | * (the "License"); you may not use this file except in compliance with | |
7 | * the License. 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 | ||
18 | package org.apache.shale.dialog.basic.model; | |
19 | ||
20 | /** | |
21 | * <p>Description of a transition from the owning {@link State} to another | |
22 | * {@link State} with a specified identifier. {@link Transition} instances | |
23 | * are owned by a single {@link State} instance, or are global to an entire | |
24 | * {@link Dialog} instance, and during execution of an application they are | |
25 | * immutable.</p> | |
26 | * | |
27 | * @since 1.0.4 | |
28 | */ | |
29 | ||
30 | public interface Transition { | |
31 | ||
32 | ||
33 | // -------------------------------------------------------------- Properties | |
34 | ||
35 | ||
36 | /** | |
37 | * <p>Return the logical outcome used to select this {@link Transition}.</p> | |
38 | * | |
39 | * @return The logical outcome that causes this {@link Transition} to be | |
40 | * followed | |
41 | */ | |
42 | public String getOutcome(); | |
43 | ||
44 | ||
45 | /** | |
46 | * <p>Return the target {@link State} identifier for this | |
47 | * {@link Transition}.</p> | |
48 | * | |
49 | * @return The identifier of the target {@link State} | |
50 | */ | |
51 | public String getTarget(); | |
52 | ||
53 | ||
54 | } |