Packages

c

com.daml.error.generator

ErrorCodeDocItem

final case class ErrorCodeDocItem(errorCodeClassName: String, category: String, hierarchicalGrouping: ErrorClass, conveyance: Option[String], code: String, deprecation: Option[DeprecatedItem], explanation: Option[Explanation], resolution: Option[Resolution]) extends Product with Serializable

Contains error presentation data to be used for documentation rendering on the website.

errorCodeClassName

The error class name (see com.daml.error.ErrorCode).

category

The error code category (see com.daml.error.ErrorCategory).

hierarchicalGrouping

The hierarchical code grouping (see com.daml.error.ErrorClass and com.daml.error.ErrorGroup).

conveyance

Provides a statement about the form this error will be returned to the user.

code

The error identifier.

explanation

The detailed error explanation.

resolution

The suggested error resolution.

Linear Supertypes
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ErrorCodeDocItem
  2. Serializable
  3. Product
  4. Equals
  5. AnyRef
  6. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new ErrorCodeDocItem(errorCodeClassName: String, category: String, hierarchicalGrouping: ErrorClass, conveyance: Option[String], code: String, deprecation: Option[DeprecatedItem], explanation: Option[Explanation], resolution: Option[Resolution])

    errorCodeClassName

    The error class name (see com.daml.error.ErrorCode).

    category

    The error code category (see com.daml.error.ErrorCategory).

    hierarchicalGrouping

    The hierarchical code grouping (see com.daml.error.ErrorClass and com.daml.error.ErrorGroup).

    conveyance

    Provides a statement about the form this error will be returned to the user.

    code

    The error identifier.

    explanation

    The detailed error explanation.

    resolution

    The suggested error resolution.

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. val category: String
  6. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
  7. val code: String
  8. val conveyance: Option[String]
  9. val deprecation: Option[DeprecatedItem]
  10. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  11. val errorCodeClassName: String
  12. val explanation: Option[Explanation]
  13. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  14. val hierarchicalGrouping: ErrorClass
  15. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  16. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  17. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  18. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  19. def productElementNames: Iterator[String]
    Definition Classes
    Product
  20. val resolution: Option[Resolution]
  21. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  22. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  23. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  24. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped