Package com.caplin.generated.motif.common

Class CommonTypesDef.Error.Builder

java.lang.Object

com.caplin.generated.motif.common.CommonTypesDef.Error.Builder

Enclosing class:

CommonTypesDef.Error

public static final class CommonTypesDef.Error.Builder
extends java.lang.Object

Method Summary

Modifier and Type	Method	Description
@NotNull CommonTypesDef.Error.Builder	addField(@NotNull java.lang.String key, @NotNull java.lang.String value)
@NotNull CommonTypesDef.Error	build()
@NotNull CommonTypesDef.Error.Builder	setErrorCode(@NotNull java.lang.String errorCode)
@NotNull CommonTypesDef.Error.Builder	setErrorMessage(@NotNull java.lang.String errorMessage)
@NotNull java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Detail

addField

@NotNull
public @NotNull CommonTypesDef.Error.Builder addField(@NotNull
                                                      @NotNull java.lang.String key,
                                                      @NotNull
                                                      @NotNull java.lang.String value)

build

@NotNull
public @NotNull CommonTypesDef.Error build()

toString

@NotNull
public @NotNull java.lang.String toString()

Overrides:

toString in class java.lang.Object

setErrorCode

@NotNull
public @NotNull CommonTypesDef.Error.Builder setErrorCode(@NotNull
                                                          @NotNull java.lang.String errorCode)

Parameters:

errorCode - e.g. rfs.stream.expired

Returns:

An error code that should be mapped to a description in their display language in the end user application

setErrorMessage

@NotNull
public @NotNull CommonTypesDef.Error.Builder setErrorMessage(@NotNull
                                                             @NotNull java.lang.String errorMessage)

Parameters:

errorMessage - e.g. Stream time of 120 second exceeded

Returns:

Additional information about the error. This information is not translatable and is typically not shown to the end user, being provided primarily for traceability. Note that this information will appear in client logs.