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

ErrorInfo

interface ErrorInfo

Standardized interface for representing error information in API responses and operations.

This interface provides a consistent structure for error reporting across the application, enabling uniform error handling, logging, and client communication. It encapsulates error codes, human-readable messages, and detailed binding errors for comprehensive error reporting.

Key features:

Success/failure status determination
Structured error codes for programmatic handling
Localized error messages for user display
Detailed binding errors for validation failures

See also

DefaultErrorInfo

for the default implementation

ErrorInfoCapable

for objects that can provide error information

Samples

Inheritors

DefaultErrorInfo

Types

object Companion

Companion object providing constants and utility functions for working with ErrorInfo instances.

Properties

open val bindingErrors: List<BindingError>

A list of detailed binding errors that occurred during data validation or mapping.

abstract val errorCode: String

The error code that uniquely identifies the type of error.

abstract val errorMsg: String

A human-readable message describing the error.

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.