Package com.caplin.generated.motif.fx.orders

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

  • Method Details

    • 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.

    • getFields

      @NotNull public @NotNull Map<String,String> getFields()
      Specified by:
      getFields in interface Message

    • getFieldFlags

      @NotNull public @NotNull Map<String,Collection<String>> getFieldFlags()
      Specified by:
      getFieldFlags in interface BuilderMessage
      Returns:
      Get the flags for all fields.

    • getFlagFields

      @NotNull public @NotNull Map<String,Collection<String>> getFlagFields()
      Specified by:
      getFlagFields in interface BuilderMessage
      Returns:
      Get the fields for all flags.

    • toString

      @NotNull public @NotNull String toString()
      Overrides:
      toString in class Object

    • 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()