org.cddcore.engine.EngineUniverse

UseCaseDescription

case class UseCaseDescription(textOrder: Int, title: Option[String] = scala.None, description: Option[String] = scala.None, children: List[Reportable] = immutable.this.Nil, expected: Option[ROrException[R]] = scala.None, optCode: Option[EngineUniverse.Code] = scala.None, priority: Option[Int] = scala.None, references: Set[Reference] = ...) extends BuilderNode with UseCase with ReportableWithTemplate with Product with Serializable

Linear Supertypes
Serializable, Serializable, Product, Equals, ReportableWithTemplate, UseCase, ReportableWithTextOrder, RequirementAndHolder, ReportableHolder, Traversable[Reportable], GenTraversable[Reportable], GenericTraversableTemplate[Reportable, Traversable], TraversableLike[Reportable, Traversable[Reportable]], GenTraversableLike[Reportable, Traversable[Reportable]], Parallelizable[Reportable, ParIterable[Reportable]], TraversableOnce[Reportable], GenTraversableOnce[Reportable], FilterMonadic[Reportable, Traversable[Reportable]], HasNewBuilder[Reportable, Traversable[Reportable]], BuilderNode, Requirement, Reportable, AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. UseCaseDescription
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. ReportableWithTemplate
  7. UseCase
  8. ReportableWithTextOrder
  9. RequirementAndHolder
  10. ReportableHolder
  11. Traversable
  12. GenTraversable
  13. GenericTraversableTemplate
  14. TraversableLike
  15. GenTraversableLike
  16. Parallelizable
  17. TraversableOnce
  18. GenTraversableOnce
  19. FilterMonadic
  20. HasNewBuilder
  21. BuilderNode
  22. Requirement
  23. Reportable
  24. AnyRef
  25. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Instance Constructors

  1. new UseCaseDescription(textOrder: Int, title: Option[String] = scala.None, description: Option[String] = scala.None, children: List[Reportable] = immutable.this.Nil, expected: Option[ROrException[R]] = scala.None, optCode: Option[EngineUniverse.Code] = scala.None, priority: Option[Int] = scala.None, references: Set[Reference] = ...)

Type Members

  1. type Self = Traversable[Reportable]

    Attributes
    protected
    Definition Classes
    TraversableLike

  2. class WithFilter extends FilterMonadic[A, Repr]

    Definition Classes
    TraversableLike

Value Members

  1. final def !=(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  2. final def !=(arg0: Any): Boolean

    Definition Classes
    Any

  3. final def ##(): Int

    Definition Classes
    AnyRef → Any

  4. def ++[B >: Reportable, That](that: GenTraversableOnce[B])(implicit bf: CanBuildFrom[Traversable[Reportable], B, That]): That

    Definition Classes
    TraversableLike → GenTraversableLike

  5. def ++:[B >: Reportable, That](that: Traversable[B])(implicit bf: CanBuildFrom[Traversable[Reportable], B, That]): That

    Definition Classes
    TraversableLike

  6. def ++:[B >: Reportable, That](that: TraversableOnce[B])(implicit bf: CanBuildFrom[Traversable[Reportable], B, That]): That

    Definition Classes
    TraversableLike

  7. def /:[B](z: B)(op: (B, Reportable) ⇒ B): B

    Definition Classes
    TraversableOnce → GenTraversableOnce

  8. def :\[B](z: B)(op: (Reportable, B) ⇒ B): B

    Definition Classes
    TraversableOnce → GenTraversableOnce

  9. final def ==(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  10. final def ==(arg0: Any): Boolean

    Definition Classes
    Any

  11. def addString(b: StringBuilder): StringBuilder

    Definition Classes
    TraversableOnce

  12. def addString(b: StringBuilder, sep: String): StringBuilder

    Definition Classes
    TraversableOnce

  13. def addString(b: StringBuilder, start: String, sep: String, end: String): StringBuilder

    Definition Classes
    TraversableOnce

  14. def aggregate[B](z: B)(seqop: (B, Reportable) ⇒ B, combop: (B, B) ⇒ B): B

    Definition Classes
    TraversableOnce → GenTraversableOnce

  15. def all[R <: Reportable](rClass: Class[R]): List[R]

    All the descendants that implement the class.

    All the descendants that implement the class. Doesn't include 'this'

    Definition Classes
    ReportableHolder

  16. def allReversed[R <: Reportable](rClass: Class[R]): List[R]

    Definition Classes
    ReportableHolder

  17. final def asInstanceOf[T0]: T0

    Definition Classes
    Any

  18. val children: List[Reportable]

    Definition Classes
    UseCaseDescription → ReportableHolder

  19. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws()

  20. def collect[B, That](pf: PartialFunction[Reportable, B])(implicit bf: CanBuildFrom[Traversable[Reportable], B, That]): That

    Definition Classes
    TraversableLike → GenTraversableLike

  21. def collectFirst[B](pf: PartialFunction[Reportable, B]): Option[B]

    Definition Classes
    TraversableOnce

  22. def companion: GenericCompanion[Traversable]

    Definition Classes
    Traversable → GenTraversable → GenericTraversableTemplate

  23. def copyToArray[B >: Reportable](xs: Array[B], start: Int, len: Int): Unit

    Definition Classes
    TraversableLike → TraversableOnce → GenTraversableOnce

  24. def copyToArray[B >: Reportable](xs: Array[B]): Unit

    Definition Classes
    TraversableOnce → GenTraversableOnce

  25. def copyToArray[B >: Reportable](xs: Array[B], start: Int): Unit

    Definition Classes
    TraversableOnce → GenTraversableOnce

  26. def copyToBuffer[B >: Reportable](dest: Buffer[B]): Unit

    Definition Classes
    TraversableOnce

  27. def count(p: (Reportable) ⇒ Boolean): Int

    Definition Classes
    TraversableOnce → GenTraversableOnce

  28. val description: Option[String]

    An optional description

    An optional description

    Definition Classes
    UseCaseDescription → Requirement

  29. def drop(n: Int): Traversable[Reportable]

    Definition Classes
    TraversableLike → GenTraversableLike

  30. def dropWhile(p: (Reportable) ⇒ Boolean): Traversable[Reportable]

    Definition Classes
    TraversableLike → GenTraversableLike

  31. final def eq(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  32. def exists(p: (Reportable) ⇒ Boolean): Boolean

    Definition Classes
    TraversableLike → TraversableOnce → GenTraversableOnce

  33. val expected: Option[ROrException[R]]

    The default expected for scenario's underneath it.

    The default expected for scenario's underneath it. It is very common for all things implementing a use case to come to the same conclusion, and using this avoids duplication and makes it clear

    Definition Classes
    UseCaseDescription → UseCase → BuilderNode

  34. def filter(p: (Reportable) ⇒ Boolean): Traversable[Reportable]

    Definition Classes
    TraversableLike → GenTraversableLike

  35. def filterNot(p: (Reportable) ⇒ Boolean): Traversable[Reportable]

    Definition Classes
    TraversableLike → GenTraversableLike

  36. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws()

  37. def find(p: (Reportable) ⇒ Boolean): Option[Reportable]

    Definition Classes
    TraversableLike → TraversableOnce → GenTraversableOnce

  38. def flatMap[B, That](f: (Reportable) ⇒ GenTraversableOnce[B])(implicit bf: CanBuildFrom[Traversable[Reportable], B, That]): That

    Definition Classes
    TraversableLike → GenTraversableLike → FilterMonadic

  39. def flatten[B](implicit asTraversable: (Reportable) ⇒ GenTraversableOnce[B]): Traversable[B]

    Definition Classes
    GenericTraversableTemplate

  40. def fold[A1 >: Reportable](z: A1)(op: (A1, A1) ⇒ A1): A1

    Definition Classes
    TraversableOnce → GenTraversableOnce

  41. def foldLeft[B](z: B)(op: (B, Reportable) ⇒ B): B

    Definition Classes
    TraversableOnce → GenTraversableOnce

  42. def foldRight[B](z: B)(op: (Reportable, B) ⇒ B): B

    Definition Classes
    TraversableOnce → GenTraversableOnce

  43. def foldWithPath[Acc](initial: Acc, fn: (Acc, ReportableList) ⇒ Acc): Acc

    folds across 'this' and all it's descendents.

    folds across 'this' and all it's descendents. The folding function takes the accumulator and the path from the descendant up to 'this' to return a new accumulator

    Definition Classes
    ReportableHolder

  44. def foldWithPathReversingChildren[Acc](initial: Acc, fn: (Acc, ReportableList) ⇒ Acc): Acc

    folds across 'this' and all it's descendents.

    folds across 'this' and all it's descendents. The folding function takes the accumulator and the path from the descendant up to 'this' to return a new accumulator In this folding operation though, all the children are reversed.

    Definition Classes
    ReportableHolder

  45. def forall(p: (Reportable) ⇒ Boolean): Boolean

    Definition Classes
    TraversableLike → TraversableOnce → GenTraversableOnce

  46. def foreach[U](f: (Reportable) ⇒ U): Unit

    Definition Classes
    ReportableHolder → GenericTraversableTemplate → TraversableLike → GenTraversableLike → TraversableOnce → GenTraversableOnce → FilterMonadic

  47. def genericBuilder[B]: Builder[B, Traversable[B]]

    Definition Classes
    GenericTraversableTemplate

  48. final def getClass(): Class[_]

    Definition Classes
    AnyRef → Any

  49. def groupBy[K](f: (Reportable) ⇒ K): Map[K, Traversable[Reportable]]

    Definition Classes
    TraversableLike → GenTraversableLike

  50. def hasDefiniteSize: Boolean

    Definition Classes
    TraversableLike → TraversableOnce → GenTraversableOnce

  51. def head: Reportable

    Definition Classes
    TraversableLike → GenTraversableLike

  52. def headOption: Option[Reportable]

    Definition Classes
    TraversableLike → GenTraversableLike

  53. def init: Traversable[Reportable]

    Definition Classes
    TraversableLike → GenTraversableLike

  54. def inits: Iterator[Traversable[Reportable]]

    Definition Classes
    TraversableLike

  55. def isEmpty: Boolean

    Definition Classes
    TraversableLike → TraversableOnce → GenTraversableOnce

  56. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any

  57. final def isTraversableAgain: Boolean

    Definition Classes
    TraversableLike → GenTraversableLike → GenTraversableOnce

  58. def last: Reportable

    Definition Classes
    TraversableLike → GenTraversableLike

  59. def lastOption: Option[Reportable]

    Definition Classes
    TraversableLike → GenTraversableLike

  60. def map[B, That](f: (Reportable) ⇒ B)(implicit bf: CanBuildFrom[Traversable[Reportable], B, That]): That

    Definition Classes
    TraversableLike → GenTraversableLike → FilterMonadic

  61. def max[B >: Reportable](implicit cmp: Ordering[B]): Reportable

    Definition Classes
    TraversableOnce → GenTraversableOnce

  62. def maxBy[B](f: (Reportable) ⇒ B)(implicit cmp: Ordering[B]): Reportable

    Definition Classes
    TraversableOnce → GenTraversableOnce

  63. def min[B >: Reportable](implicit cmp: Ordering[B]): Reportable

    Definition Classes
    TraversableOnce → GenTraversableOnce

  64. def minBy[B](f: (Reportable) ⇒ B)(implicit cmp: Ordering[B]): Reportable

    Definition Classes
    TraversableOnce → GenTraversableOnce

  65. def mkString: String

    Definition Classes
    TraversableOnce → GenTraversableOnce

  66. def mkString(sep: String): String

    Definition Classes
    TraversableOnce → GenTraversableOnce

  67. def mkString(start: String, sep: String, end: String): String

    Definition Classes
    TraversableOnce → GenTraversableOnce

  68. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  69. def newBuilder: Builder[Reportable, Traversable[Reportable]]

    Attributes
    protected[this]
    Definition Classes
    GenericTraversableTemplate → HasNewBuilder

  70. def nonEmpty: Boolean

    Definition Classes
    TraversableOnce → GenTraversableOnce

  71. final def notify(): Unit

    Definition Classes
    AnyRef

  72. final def notifyAll(): Unit

    Definition Classes
    AnyRef

  73. val optCode: Option[EngineUniverse.Code]

    The default 'code' for scenario's underneath it.

    The default 'code' for scenario's underneath it. It is very common for all things implementing a use case to use the same code block, and using this makes that clear

    Definition Classes
    UseCaseDescription → UseCase → BuilderNode

  74. def par: ParIterable[Reportable]

    Definition Classes
    Parallelizable

  75. def parCombiner: Combiner[Reportable, ParIterable[Reportable]]

    Attributes
    protected[this]
    Definition Classes
    TraversableLike → Parallelizable

  76. def partition(p: (Reportable) ⇒ Boolean): (Traversable[Reportable], Traversable[Reportable])

    Definition Classes
    TraversableLike → GenTraversableLike

  77. val priority: Option[Int]

    The 'priority' that is used to determine the order that the decision trees are being built

    The 'priority' that is used to determine the order that the decision trees are being built

    Definition Classes
    UseCaseDescription → Requirement

  78. def product[B >: Reportable](implicit num: Numeric[B]): B

    Definition Classes
    TraversableOnce → GenTraversableOnce

  79. def reduce[A1 >: Reportable](op: (A1, A1) ⇒ A1): A1

    Definition Classes
    TraversableOnce → GenTraversableOnce

  80. def reduceLeft[B >: Reportable](op: (B, Reportable) ⇒ B): B

    Definition Classes
    TraversableOnce

  81. def reduceLeftOption[B >: Reportable](op: (B, Reportable) ⇒ B): Option[B]

    Definition Classes
    TraversableOnce → GenTraversableOnce

  82. def reduceOption[A1 >: Reportable](op: (A1, A1) ⇒ A1): Option[A1]

    Definition Classes
    TraversableOnce → GenTraversableOnce

  83. def reduceRight[B >: Reportable](op: (Reportable, B) ⇒ B): B

    Definition Classes
    TraversableOnce → GenTraversableOnce

  84. def reduceRightOption[B >: Reportable](op: (Reportable, B) ⇒ B): Option[B]

    Definition Classes
    TraversableOnce → GenTraversableOnce

  85. val references: Set[Reference]

    Definition Classes
    UseCaseDescription → Requirement

  86. def repr: Traversable[Reportable]

    Definition Classes
    TraversableLike → GenTraversableLike

  87. def reversed: List[Reportable]

    Attributes
    protected[this]
    Definition Classes
    TraversableOnce

  88. def scan[B >: Reportable, That](z: B)(op: (B, B) ⇒ B)(implicit cbf: CanBuildFrom[Traversable[Reportable], B, That]): That

    Definition Classes
    TraversableLike → GenTraversableLike

  89. def scanLeft[B, That](z: B)(op: (B, Reportable) ⇒ B)(implicit bf: CanBuildFrom[Traversable[Reportable], B, That]): That

    Definition Classes
    TraversableLike → GenTraversableLike

  90. def scanRight[B, That](z: B)(op: (Reportable, B) ⇒ B)(implicit bf: CanBuildFrom[Traversable[Reportable], B, That]): That

    Definition Classes
    TraversableLike → GenTraversableLike
    Annotations
    @migration
    Migration

    (Changed in version 2.9.0) The behavior of scanRight has changed. The previous behavior can be reproduced with scanRight.reverse.

  91. def seq: Traversable[Reportable]

    Definition Classes
    Traversable → GenTraversable → Parallelizable → TraversableOnce → GenTraversableOnce

  92. def size: Int

    Definition Classes
    TraversableOnce → GenTraversableOnce

  93. def slice(from: Int, until: Int): Traversable[Reportable]

    Definition Classes
    TraversableLike → GenTraversableLike

  94. def span(p: (Reportable) ⇒ Boolean): (Traversable[Reportable], Traversable[Reportable])

    Definition Classes
    TraversableLike → GenTraversableLike

  95. def splitAt(n: Int): (Traversable[Reportable], Traversable[Reportable])

    Definition Classes
    TraversableLike → GenTraversableLike

  96. def stringPrefix: String

    Definition Classes
    TraversableLike → GenTraversableLike

  97. def sum[B >: Reportable](implicit num: Numeric[B]): B

    Definition Classes
    TraversableOnce → GenTraversableOnce

  98. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef

  99. def tail: Traversable[Reportable]

    Definition Classes
    TraversableLike → GenTraversableLike

  100. def tails: Iterator[Traversable[Reportable]]

    Definition Classes
    TraversableLike

  101. def take(n: Int): Traversable[Reportable]

    Definition Classes
    TraversableLike → GenTraversableLike

  102. def takeWhile(p: (Reportable) ⇒ Boolean): Traversable[Reportable]

    Definition Classes
    TraversableLike → GenTraversableLike

  103. val templateName: String

    Definition Classes
    UseCaseDescription → ReportableWithTemplate

  104. val textOrder: Int

    Definition Classes
    UseCaseDescription → ReportableWithTextOrder

  105. def thisCollection: Traversable[Reportable]

    Attributes
    protected[this]
    Definition Classes
    TraversableLike

  106. val title: Option[String]

    this will appear on reports as a title for that requirement

    this will appear on reports as a title for that requirement

    Definition Classes
    UseCaseDescription → Requirement

  107. def titleOrDescription(default: String): String

    the title or if undefined the description or if undefined the default

    the title or if undefined the description or if undefined the default

    Definition Classes
    Requirement

  108. def titleString: String

    the title or an empty string

    the title or an empty string

    Definition Classes
    Requirement

  109. def to[Col[_]](implicit cbf: CanBuildFrom[Nothing, Reportable, Col[Reportable]]): Col[Reportable]

    Definition Classes
    TraversableLike → TraversableOnce → GenTraversableOnce

  110. def toArray[B >: Reportable](implicit arg0: ClassTag[B]): Array[B]

    Definition Classes
    TraversableOnce → GenTraversableOnce

  111. def toBuffer[B >: Reportable]: Buffer[B]

    Definition Classes
    TraversableOnce → GenTraversableOnce

  112. def toCollection(repr: Traversable[Reportable]): Traversable[Reportable]

    Attributes
    protected[this]
    Definition Classes
    TraversableLike

  113. def toIndexedSeq: IndexedSeq[Reportable]

    Definition Classes
    TraversableOnce → GenTraversableOnce

  114. def toIterable: Iterable[Reportable]

    Definition Classes
    TraversableOnce → GenTraversableOnce

  115. def toIterator: Iterator[Reportable]

    Definition Classes
    TraversableLike → GenTraversableOnce

  116. def toList: List[Reportable]

    Definition Classes
    TraversableOnce → GenTraversableOnce

  117. def toMap[T, U](implicit ev: <:<[Reportable, (T, U)]): Map[T, U]

    Definition Classes
    TraversableOnce → GenTraversableOnce

  118. def toSeq: Seq[Reportable]

    Definition Classes
    TraversableOnce → GenTraversableOnce

  119. def toSet[B >: Reportable]: Set[B]

    Definition Classes
    TraversableOnce → GenTraversableOnce

  120. def toStream: Stream[Reportable]

    Definition Classes
    TraversableLike → GenTraversableOnce

  121. def toString(): String

    Definition Classes
    UseCaseDescription → TraversableLike → AnyRef → Any

  122. def toTraversable: Traversable[Reportable]

    Definition Classes
    TraversableLike → TraversableOnce → GenTraversableOnce

  123. def toVector: Vector[Reportable]

    Definition Classes
    TraversableOnce → GenTraversableOnce

  124. def transpose[B](implicit asTraversable: (Reportable) ⇒ GenTraversableOnce[B]): Traversable[Traversable[B]]

    Definition Classes
    GenericTraversableTemplate
    Annotations
    @migration
    Migration

    (Changed in version 2.9.0) transpose throws an IllegalArgumentException if collections are not uniformly sized.

  125. def unzip[A1, A2](implicit asPair: (Reportable) ⇒ (A1, A2)): (Traversable[A1], Traversable[A2])

    Definition Classes
    GenericTraversableTemplate

  126. def unzip3[A1, A2, A3](implicit asTriple: (Reportable) ⇒ (A1, A2, A3)): (Traversable[A1], Traversable[A2], Traversable[A3])

    Definition Classes
    GenericTraversableTemplate

  127. def view(from: Int, until: Int): TraversableView[Reportable, Traversable[Reportable]]

    Definition Classes
    TraversableLike

  128. def view: TraversableView[Reportable, Traversable[Reportable]]

    Definition Classes
    TraversableLike

  129. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws()

  130. final def wait(arg0: Long, arg1: Int): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws()

  131. final def wait(arg0: Long): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws()

  132. def walkWithPath(path: ReportableList, visitor: (ReportableList) ⇒ Unit): Unit

    Attributes
    protected
    Definition Classes
    ReportableHolder

  133. def walkWithPath(visitor: (ReportableList) ⇒ Unit): Unit

    Calls this visitor with 'this' and all it's descendents.

    Calls this visitor with 'this' and all it's descendents. The parameter to visitor is the path from the head back up to 'this'. So head will be the deepest reportable

    Definition Classes
    ReportableHolder

  134. def withFilter(p: (Reportable) ⇒ Boolean): FilterMonadic[Reportable, Traversable[Reportable]]

    Definition Classes
    TraversableLike → FilterMonadic

Deprecated Value Members

  1. def /:\[A1 >: Reportable](z: A1)(op: (A1, A1) ⇒ A1): A1

    Definition Classes
    GenTraversableOnce
    Annotations
    @deprecated
    Deprecated

    (Since version 2.10.0) use fold instead

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from ReportableWithTemplate

Inherited from UseCase

Inherited from ReportableWithTextOrder

Inherited from RequirementAndHolder

Inherited from ReportableHolder

Inherited from Traversable[Reportable]

Inherited from GenTraversable[Reportable]

Inherited from GenericTraversableTemplate[Reportable, Traversable]

Inherited from TraversableLike[Reportable, Traversable[Reportable]]

Inherited from GenTraversableLike[Reportable, Traversable[Reportable]]

Inherited from Parallelizable[Reportable, ParIterable[Reportable]]

Inherited from TraversableOnce[Reportable]

Inherited from GenTraversableOnce[Reportable]

Inherited from FilterMonadic[Reportable, Traversable[Reportable]]

Inherited from HasNewBuilder[Reportable, Traversable[Reportable]]

Inherited from BuilderNode

Inherited from Requirement

Inherited from Reportable

Inherited from AnyRef

Inherited from Any

Ungrouped