Class OrderAuditTypesDef.OrderLegAuditAction
- java.lang.Object
-
- com.caplin.generated.motif.fx.orders.OrderAuditTypesDef.OrderLegAuditAction
-
- All Implemented Interfaces:
BuilderMessage
,Message
- Enclosing class:
- OrderAuditTypesDef
public static final class OrderAuditTypesDef.OrderLegAuditAction extends Object implements BuilderMessage
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
OrderAuditTypesDef.OrderLegAuditAction.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static @NotNull OrderAuditTypesDef.OrderLegAuditAction
from(@NotNull Map<String,String> fields)
static @NotNull OrderAuditTypesDef.OrderLegAuditAction
from(@NotNull Map<String,String> fields, @NotNull String fieldPrefix)
@Nullable String
getActionBy()
@Nullable Integer
getActionCode()
@Nullable Instant
getActionDateTime()
@Nullable String
getAuditParameter1()
@Nullable String
getAuditParameter2()
@Nullable String
getAuditParameter3()
@Nullable String
getAuditParameter4()
@Nullable String
getAuditParameter5()
@NotNull Map<String,Collection<String>>
getFieldFlags()
@NotNull Map<String,String>
getFields()
@NotNull Map<String,Collection<String>>
getFlagFields()
@Nullable String
getOrderID()
@Nullable String
getOrderStatus()
@Nullable Integer
getVersion()
static @NotNull OrderAuditTypesDef.OrderLegAuditAction.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
-
getOrderID
@Nullable public @Nullable String getOrderID()
- Returns:
- The id of the order.
-
getVersion
@Nullable public @Nullable Integer getVersion()
- Returns:
- The resulting version of this leg.
-
getActionDateTime
@Nullable public @Nullable Instant getActionDateTime()
- Returns:
- actionDateTime
-
getActionBy
@Nullable public @Nullable String getActionBy()
- Returns:
- Which user triggered the action to occur.
-
getOrderStatus
@Nullable public @Nullable String getOrderStatus()
- Returns:
- Caplin supported statuses are [PENDING-ACCEPT, PENDING-ACTIVATION, ACTIVE, PARENT-ACTIVE, PENDING-DEACTIVATION, DEACTIVATED, EXPIRED, COMPLETED, REJECTED, PENDING-CANCEL, CANCELLED, CANCELLED-BY-PARTNER]
-
getActionCode
@Nullable public @Nullable Integer getActionCode()
- Returns:
- Code for the action reason, to be translated by i18n. Constants are provided in the class ActionCode. Parameters for the translated message can be provided in the AuditParameter# fields. Custom codes should begin from 1000. If you don't want to provide a translation on the front end, you can send '9999' (or ActionCode.NON_TRANSLATABLE) and supply plain text in AuditParameter1.
-
getAuditParameter1
@Nullable public @Nullable String getAuditParameter1()
- Returns:
- Parameter to be placed into the translated action reason.
-
getAuditParameter2
@Nullable public @Nullable String getAuditParameter2()
- Returns:
- Parameter to be placed into the translated action reason.
-
getAuditParameter3
@Nullable public @Nullable String getAuditParameter3()
- Returns:
- Parameter to be placed into the translated action reason.
-
getAuditParameter4
@Nullable public @Nullable String getAuditParameter4()
- Returns:
- Parameter to be placed into the translated action reason.
-
getAuditParameter5
@Nullable public @Nullable String getAuditParameter5()
- Returns:
- Parameter to be placed into the translated action reason.
-
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 OrderAuditTypesDef.OrderLegAuditAction from(@NotNull @NotNull Map<String,String> fields)
-
from
@NotNull public static @NotNull OrderAuditTypesDef.OrderLegAuditAction from(@NotNull @NotNull Map<String,String> fields, @NotNull @NotNull String fieldPrefix)
-
newBuilder
@NotNull public static @NotNull OrderAuditTypesDef.OrderLegAuditAction.Builder newBuilder()
-
-