StoryDefinition

All Implemented Interfaces:

ai.tock.bot.definition.IntentAware
```
public interface StoryDefinition
 implements 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 SimpleStoryHandlerBase or StoryDefinitionBase.

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description

Field Summary

Fields
Modifier and Type	Field	Description

Constructor Summary

Constructors
Constructor	Description

Enum Constant Summary

Enum Constants
Enum Constant	Description

Method Summary

Modifier and Type	Method	Description
`Boolean`	`hasTag(StoryTag tag)`	Does this story is tagged with specified tag?
`Boolean`	`isStarterIntent(Intent intent)`	Is the specified intent is a starter intent?
`Boolean`	`supportIntent(Intent intent)`	Is the specified intent is supported by this story?
`Intent`	`mainIntent()`	The "referent" intent for this story.
`Intent`	`wrappedIntent()`	Implementation for IntentAware.
`Set<StoryStep<?>>`	`allSteps()`	Returns all steps of the story.
`abstract String`	`getId()`	An unique identifier for a given bot.
`abstract Set<Intent>`	`getStarterIntents()`	One or more intents that start the story.
`abstract Set<Intent>`	`getIntents()`	The complete list of intents supported by the story.
`Set<StoryTag>`	`getTags()`
`abstract StoryHandler`	`getStoryHandler()`	The story handler of the story.
`abstract Set<StoryStep<?>>`	`getSteps()`	The root steps of the story.
`Boolean`	`getMetricStory()`
`abstract Set<UserInterfaceType>`	`getUnsupportedUserInterfaces()`	When this story does not support all UserInterfaceTypes.

Methods inherited from class ai.tock.bot.definition.IntentAware
intentWithoutNamespace, wrap
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
- Method Detail
  - hasTag
```
 Boolean hasTag(StoryTag tag)
```
    Does this story is tagged with specified tag?
  - isStarterIntent
```
 Boolean isStarterIntent(Intent intent)
```
    Is the specified intent is a starter intent?
  - supportIntent
```
 Boolean supportIntent(Intent intent)
```
    Is the specified intent is supported by this story?
  - mainIntent
```
 Intent mainIntent()
```
    The "referent" intent for this story.
  - wrappedIntent
```
 Intent wrappedIntent()
```
    Implementation for IntentAware.
  - allSteps
```
 Set<StoryStep<?>> allSteps()
```
    Returns all steps of the story.
  - getId
```
 abstract String getId()
```
    An unique identifier for a given bot.
  - getStarterIntents
```
 abstract Set<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
```
 abstract Set<Intent> getIntents()
```
    The complete list of intents supported by the story.
  - getTags
```
 Set<StoryTag> getTags()
```
  - getStoryHandler
```
 abstract StoryHandler getStoryHandler()
```
    The story handler of the story.
  - getSteps
```
 abstract Set<StoryStep<?>> getSteps()
```
    The root steps of the story.
  - getMetricStory
```
 Boolean getMetricStory()
```
  - getUnsupportedUserInterfaces
```
 abstract Set<UserInterfaceType> getUnsupportedUserInterfaces()
```
    When this story does not support all UserInterfaceTypes.