case class Story(loc: At, id: Definitions.Identifier, userStory: Option[UserStory] = Option.empty[UserStory], shownBy: Seq[java.net.URL] = Seq.empty[java.net.URL], cases: Seq[UseCase] = Seq.empty[UseCase], examples: Seq[Example] = Seq.empty[Example], authors: Seq[AuthorRef] = Seq.empty[AuthorRef], includes: Seq[Include[StoryDefinition]] = Seq
.empty[Include[StoryDefinition]], options: Seq[Definitions.StoryOption] = Seq.empty[StoryOption], terms: Seq[Term] = Seq.empty[Term], brief: Option[Definitions.LiteralString] = Option.empty[LiteralString], description: Option[Definitions.Description] = None) extends VitalDefinition[StoryOption, StoryDefinition] with DomainDefinition with Product with Serializable
The definition of an Jacobsen use case which focuses on a story. Stories define functionality from the perspective of actor's (man or machine) interaction with the system that is part of their role. RIDDL defines these stories by allowing a linkage between the actor and RIDDL applications or bounded contexts.
- loc
The location of the story definition
- id
The name of the story
- userStory
The user story per agile and xP (I as a >role< need >feature< so that >reason>)
- shownBy
A list of URLs to visualizations or other materials related to the story
- cases
A list of UseCase's that define the story
- examples
Gherkin examples to specify "done" for the implementation of the user story
- brief
A brief description (one sentence) for use in documentation
- description
An optional description of the
- Alphabetic
- By Inheritance
- Story
- Serializable
- Product
- Equals
- DomainDefinition
- VitalDefinition
- WithTerms
- WithIncludes
- WithAuthors
- WithOptions
- Definition
- Container
- BrieflyDescribedValue
- DescribedValue
- RiddlValue
- RiddlNode
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Instance Constructors
- new Story(loc: At, id: Definitions.Identifier, userStory: Option[UserStory] = Option.empty[UserStory], shownBy: Seq[java.net.URL] = Seq.empty[java.net.URL], cases: Seq[UseCase] = Seq.empty[UseCase], examples: Seq[Example] = Seq.empty[Example], authors: Seq[AuthorRef] = Seq.empty[AuthorRef], includes: Seq[Include[StoryDefinition]] = Seq
.empty[Include[StoryDefinition]], options: Seq[Definitions.StoryOption] = Seq.empty[StoryOption], terms: Seq[Term] = Seq.empty[Term], brief: Option[Definitions.LiteralString] = Option.empty[LiteralString], description: Option[Definitions.Description] = None)- loc
The location of the story definition
- id
The name of the story
- userStory
The user story per agile and xP (I as a >role< need >feature< so that >reason>)
- shownBy
A list of URLs to visualizations or other materials related to the story
- cases
A list of UseCase's that define the story
- examples
Gherkin examples to specify "done" for the implementation of the user story
- brief
A brief description (one sentence) for use in documentation
- description
An optional description of the
Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- val authors: Seq[AuthorRef]
- Definition Classes
- Story → WithAuthors
- implicit def bool2int(b: Boolean): Int
Implicit conversion of boolean to Int for easier computation of statistics below
Implicit conversion of boolean to Int for easier computation of statistics below
- b
The boolean to convert to an Int
- Definition Classes
- VitalDefinition
- val brief: Option[Definitions.LiteralString]
- Definition Classes
- Story → BrieflyDescribedValue
- def briefValue: String
- Definition Classes
- BrieflyDescribedValue
- val cases: Seq[UseCase]
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native() @IntrinsicCandidate()
- def completeness: (Int, Int)
Compute the completeness of this definition.
Compute the completeness of this definition. Vital definitions should have options, terms, and authors but includes are optional. Incompleteness is signalled by child definitions that are empty.
- returns
A numerator and denominator for percent complete
- Definition Classes
- VitalDefinition
- def contents: Seq[StoryDefinition]
- Definition Classes
- Story → WithIncludes → Container
- val description: Option[Definitions.Description]
- Definition Classes
- Story → DescribedValue
- def descriptionValue: String
- Definition Classes
- DescribedValue
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- val examples: Seq[Example]
- def find(name: String): Option[Definitions.Definition]
- Definition Classes
- Definition
- def format: String
Format the node to a string
Format the node to a string
- Definition Classes
- Story → WithOptions → RiddlNode
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @IntrinsicCandidate()
- def getOptionValue[OPT <: Definitions.StoryOption](implicit arg0: ClassTag[OPT]): Option[Seq[Definitions.LiteralString]]
- Definition Classes
- WithOptions
- def hasAuthors: Boolean
- Definition Classes
- WithAuthors → Definition
- def hasOption[OPT <: Definitions.StoryOption](implicit arg0: ClassTag[OPT]): Boolean
- Definition Classes
- WithOptions
- def hasOptions: Boolean
- Definition Classes
- WithOptions → Definition
- def hasTerms: Boolean
- Definition Classes
- WithTerms
- def hasTypes: Boolean
- Definition Classes
- Definition
- val id: Definitions.Identifier
- Definition Classes
- Story → Definition
- def identify: String
- Definition Classes
- Definition
- def identifyWithLoc: String
- Definition Classes
- Definition
- val includes: Seq[Include[StoryDefinition]]
- Definition Classes
- Story → WithIncludes
- def isContainer: Boolean
Determine if this node is a container or not
- def isEmpty: Boolean
determine if this node is empty or not.
determine if this node is empty or not. Non-containers are always empty
- Definition Classes
- Story → WithOptions → Container → RiddlNode
- def isImplicit: Boolean
- Definition Classes
- Definition
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- def isRootContainer: Boolean
- Definition Classes
- Container
- def isVital: Boolean
- Definition Classes
- VitalDefinition → Definition
- final val kind: String
- Definition Classes
- Story → Definition
- val loc: At
The location in the parse at which this RiddlValue occurs
The location in the parse at which this RiddlValue occurs
- Definition Classes
- Story → RiddlValue
- def maturity: Int
Compute the 'maturity' of a definition.
Compute the 'maturity' of a definition. Maturity is a score with no maximum but with scoring rules that target 100 points per definition. Maturity is broken down this way:
- has a description - up to 50 points depending on # of non empty lines
- has a brief description - 5 points
- has options specified - 5 points
- has terms defined -
- has an author in or above the definition - 5 points \-
- definition specific things: 0.65
- Definition Classes
- Story → VitalDefinition
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def nonEmpty: Boolean
- Definition Classes
- RiddlNode
- Annotations
- @deprecatedOverriding()
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @IntrinsicCandidate()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @IntrinsicCandidate()
- val options: Seq[Definitions.StoryOption]
- Definition Classes
- Story → WithOptions
- def productElementNames: Iterator[String]
- Definition Classes
- Product
- val shownBy: Seq[java.net.URL]
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- val terms: Seq[Term]
- val userStory: Option[UserStory]
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
Deprecated Value Members
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable]) @Deprecated
- Deprecated