fr.vsct.tock.bot.definition.StoryDefinitionExtended.kt Maven / Gradle / Ivy

Go to download
/*
 * Copyright (C) 2017 VSCT
 *
 * 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.
 */

package fr.vsct.tock.bot.definition

import fr.vsct.tock.translator.UserInterfaceType

/**
 * Helper methods for StoryDefinition implementation.
 * Usually direct implementations are enums.
 * This interface add a starter (and main) intent with intent name equals to the property of value [name]
 * to the [StoryDefinition].
 * Warning: advanced usage only.
 */
interface StoryDefinitionExtended : StoryDefinition {

    val otherStarterIntents: Set get() = emptySet()
    val secondaryIntents: Set get() = emptySet()

    /**
     * StoryStep implementation could be an enum
     */
    val stepsArray: Array> get() = emptyArray()
    override val steps: Set> get() = stepsArray.toSet()

    val unsupportedUserInterface: UserInterfaceType? get() = null
    override val unsupportedUserInterfaces: Set get() = listOfNotNull(unsupportedUserInterface).toSet()

    val name: String
    override val id: String get() = name
    override val starterIntents: Set get() = setOf(Intent(name)) + otherStarterIntents.map { it.wrappedIntent() }.toSet()
    override val intents: Set get() = setOf(Intent(name)) + (otherStarterIntents + secondaryIntents).map { it.wrappedIntent() }.toSet()
}