case class Story(loc: Location, id: AST.Identifier, role: AST.LiteralString = LiteralString.empty, capability: AST.LiteralString = LiteralString.empty, benefit: AST.LiteralString = LiteralString.empty, shownBy: Seq[java.net.URL] = Seq.empty[java.net.URL], implementedBy: Seq[DomainRef] = Seq.empty[DomainRef], examples: Seq[Example] = Seq.empty[Example], authors: Seq[AuthorInfo] = Seq.empty[AuthorInfo], brief: Option[AST.LiteralString] = Option.empty[LiteralString], description: Option[AST.Description] = None) extends DomainDefinition with WithAuthors with Product with Serializable
The definition of an agile user story. Stories define functionality from the perspective of a certain kind of user (man or machine), interacting with the system via some role. RIDDL extends the notion of an agile user story by allowing a linkage between the story and the RIDDL features that implement it.
- loc
The location of the story definition
- id
The name of the story
- role
The role of the actor involved in the story
- capability
The capability utilized by the actor in the story
- benefit
The benefit, to the user, of using the capability.
- shownBy
A list of URLs to visualizations or other materials related to the story
- implementedBy
A list of PathIdentifiers, presumably contexts, that implement 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
- WithAuthors
- DomainDefinition
- Definition
- Container
- BrieflyDescribedValue
- DescribedValue
- RiddlValue
- RiddlNode
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Instance Constructors
- new Story(loc: Location, id: AST.Identifier, role: AST.LiteralString = LiteralString.empty, capability: AST.LiteralString = LiteralString.empty, benefit: AST.LiteralString = LiteralString.empty, shownBy: Seq[java.net.URL] = Seq.empty[java.net.URL], implementedBy: Seq[DomainRef] = Seq.empty[DomainRef], examples: Seq[Example] = Seq.empty[Example], authors: Seq[AuthorInfo] = Seq.empty[AuthorInfo], brief: Option[AST.LiteralString] = Option.empty[LiteralString], description: Option[AST.Description] = None)
- loc
The location of the story definition
- id
The name of the story
- role
The role of the actor involved in the story
- capability
The capability utilized by the actor in the story
- benefit
The benefit, to the user, of using the capability.
- shownBy
A list of URLs to visualizations or other materials related to the story
- implementedBy
A list of PathIdentifiers, presumably contexts, that implement 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[AuthorInfo]
- Definition Classes
- Story → WithAuthors
- val benefit: AST.LiteralString
- val brief: Option[AST.LiteralString]
- Definition Classes
- Story → BrieflyDescribedValue
- val capability: AST.LiteralString
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native() @IntrinsicCandidate()
- def contents: Seq[AST.StoryDefinition]
- val description: Option[AST.Description]
- Definition Classes
- Story → DescribedValue
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- val examples: Seq[Example]
- def format: String
Format the node to a string
Format the node to a string
- Definition Classes
- RiddlNode
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @IntrinsicCandidate()
- def hasAuthors: Boolean
- Definition Classes
- WithAuthors → Definition
- def hasOptions: Boolean
- Definition Classes
- Definition
- def hasTypes: Boolean
- Definition Classes
- Definition
- val id: AST.Identifier
- Definition Classes
- Story → Definition
- def identify: String
- Definition Classes
- Definition
- def identifyWithLoc: String
- Definition Classes
- Definition
- val implementedBy: Seq[DomainRef]
- def isContainer: Boolean
Determine if this node is a container or not
- def isEmpty: Boolean
determine if this node is empty or not.
- def isImplicit: Boolean
- Definition Classes
- Definition
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- def isRootContainer: Boolean
- Definition Classes
- Container
- final val kind: String
- Definition Classes
- Story → Definition
- def kindId: String
- Definition Classes
- Definition
- val loc: Location
The location in the parse at which this RiddlValue occurs
The location in the parse at which this RiddlValue occurs
- Definition Classes
- Story → RiddlValue
- 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()
- def productElementNames: Iterator[String]
- Definition Classes
- Product
- val role: AST.LiteralString
- val shownBy: Seq[java.net.URL]
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- 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