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>A {@link SubdialogState} represents the execution of a separate
22 * {@link Dialog}, after which processing proceeds within the current
23 * {@link Dialog} based upon the logical outcome returned by the
24 * {@link EndState} of the subordinate dialog.</p>
25 *
26 * @since 1.0.4
27 */
28
29 public interface SubdialogState extends State {
30
31
32 // -------------------------------------------------------------- Properties
33
34
35 /***
36 * <p>Return the name of the subordinate dialog to be executed
37 * by this state.</p>
38 *
39 * @return The name of the subdialog to be executed
40 */
41 public String getDialogName();
42
43
44 }