ai.tock.bot.definition

Interface StoryDefinition

All Superinterfaces:

IntentAware

All Known Subinterfaces:

StoryDefinitionExtended

All Known Implementing Classes:

SimpleStoryDefinition, StoryDefinitionBase

public StoryDefinition
extends IntentAware

The definition of a "Story". A story holds a list of actions of the same domain. The story provides a set of starter intents. When theses intents are detected, The story is started.

Story definitions should usually not directly extend this class, but instead extend class SimpleStoryHandlerBase or class StoryDefinitionBase.

See Also:

class SimpleStoryHandlerBase, class StoryDefinitionBase

Constructor Detail

StoryDefinition

public StoryDefinition()

Method Detail

getId

@NotNull
java.lang.String getId()

An unique identifier for a given bot.

getStarterIntents

@NotNull
java.util.Set<ai.tock.bot.definition.Intent> getStarterIntents()

One or more intents that start the story. Usually, you don't have the same starter intent in two different story definition.

getIntents

@NotNull
java.util.Set<ai.tock.bot.definition.Intent> getIntents()

The complete list of intents supported by the story.

getStoryHandler

@NotNull
StoryHandler getStoryHandler()

The story handler of the story.

getSteps

@NotNull
java.util.Set<ai.tock.bot.definition.StoryStep> getSteps()

The root steps of the story.

getUnsupportedUserInterfaces

@NotNull
java.util.Set<ai.tock.translator.UserInterfaceType> getUnsupportedUserInterfaces()

When this story does not support all UserInterfaceTypes.

isStarterIntent

boolean isStarterIntent(@NotNull
                        Intent intent)

Is the specified intent is a starter intent?

supportIntent

boolean supportIntent(@NotNull
                      Intent intent)

Is the specified intent is supported by this story?

mainIntent

@NotNull
Intent mainIntent()

The "referent" intent for this story.

wrappedIntent

@NotNull
Intent wrappedIntent()

Implementation for interface IntentAware.

See Also:

interface IntentAware

allSteps

@NotNull
java.util.Set<ai.tock.bot.definition.StoryStep> allSteps()