wow-api/me.ahoo.wow.api.exception/DefaultErrorInfo

DefaultErrorInfo

data class DefaultErrorInfo(val errorCode: String, val errorMsg: String = "", val bindingErrors: List<BindingError> = emptyList()) : ErrorInfo, Materialized

Default implementation of the ErrorInfo interface.

This data class provides a concrete, serializable implementation of error information that can be used directly in API responses, logging, and error handling. It implements Materialized to ensure it can be properly serialized in JSON responses and stored in databases.

See also

for the interface definition

ErrorInfo.Companion.of

for convenient factory method

Samples

Constructors

DefaultErrorInfo

constructor(errorCode: String, errorMsg: String = "", bindingErrors: List<BindingError> = emptyList())

Properties

open override val bindingErrors: List<BindingError>

A list of field-level validation errors (empty by default)

open override val errorCode: String

The error code that identifies the type of error

open override val errorMsg: String

A human-readable message describing the error (empty for success)

open val succeeded: Boolean

Indicates whether the operation was successful.

Functions

fun ErrorInfo.materialize(): ErrorInfo

Converts this ErrorInfo to a materialized instance for serialization.

fun ErrorInfo.toDefault(): DefaultErrorInfo

Converts this ErrorInfo to a DefaultErrorInfo instance.