Class CommonTypesDef.Error
- java.lang.Object
-
- com.caplin.generated.motif.common.CommonTypesDef.Error
-
- All Implemented Interfaces:
BuilderMessage
,Message
- Enclosing class:
- CommonTypesDef
public static final class CommonTypesDef.Error extends Object implements BuilderMessage
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
CommonTypesDef.Error.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static @NotNull CommonTypesDef.Error
from(@NotNull Map<String,String> fields)
static @NotNull CommonTypesDef.Error
from(@NotNull Map<String,String> fields, @NotNull String fieldPrefix)
@Nullable String
getErrorCode()
@Nullable String
getErrorMessage()
@NotNull Map<String,Collection<String>>
getFieldFlags()
@NotNull Map<String,String>
getFields()
@NotNull Map<String,Collection<String>>
getFlagFields()
static @NotNull CommonTypesDef.Error.Builder
newBuilder()
@NotNull String
toString()
-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface com.caplin.motif.datasource.BuilderMessage
getFieldFlags, getFlagFields
-
-
-
-
Method Detail
-
getErrorCode
@Nullable public @Nullable String getErrorCode()
- Returns:
- An error code that should be mapped to a description in their display language in the end user application
-
getErrorMessage
@Nullable public @Nullable String getErrorMessage()
- 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.
-
getFieldFlags
@NotNull public @NotNull Map<String,Collection<String>> getFieldFlags()
- Specified by:
getFieldFlags
in interfaceBuilderMessage
- Returns:
- Get the flags for all fields.
-
getFlagFields
@NotNull public @NotNull Map<String,Collection<String>> getFlagFields()
- Specified by:
getFlagFields
in interfaceBuilderMessage
- Returns:
- Get the fields for all flags.
-
from
@NotNull public static @NotNull CommonTypesDef.Error from(@NotNull @NotNull Map<String,String> fields)
-
from
@NotNull public static @NotNull CommonTypesDef.Error from(@NotNull @NotNull Map<String,String> fields, @NotNull @NotNull String fieldPrefix)
-
newBuilder
@NotNull public static @NotNull CommonTypesDef.Error.Builder newBuilder()
-
-