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

Class OrderAuditTypesDef.OrderLegAuditAction.Builder

java.lang.Object

com.caplin.generated.motif.fx.orders.OrderAuditTypesDef.OrderLegAuditAction.Builder

Enclosing class:

OrderAuditTypesDef.OrderLegAuditAction

public static final class OrderAuditTypesDef.OrderLegAuditAction.Builder
extends java.lang.Object

Method Summary

Modifier and Type	Method	Description
@NotNull OrderAuditTypesDef.OrderLegAuditAction.Builder	addField(@NotNull java.lang.String key, @NotNull java.lang.String value)
@NotNull OrderAuditTypesDef.OrderLegAuditAction	build()
@NotNull OrderAuditTypesDef.OrderLegAuditAction.Builder	setActionBy(@NotNull java.lang.String actionBy)
@NotNull OrderAuditTypesDef.OrderLegAuditAction.Builder	setActionCode(int actionCode)
@NotNull OrderAuditTypesDef.OrderLegAuditAction.Builder	setActionCode(@NotNull java.lang.String actionCode)
@NotNull OrderAuditTypesDef.OrderLegAuditAction.Builder	setActionDateTime(@NotNull java.lang.String actionDateTime)
@NotNull OrderAuditTypesDef.OrderLegAuditAction.Builder	setActionDateTime(@NotNull java.time.Instant actionDateTime)
@NotNull OrderAuditTypesDef.OrderLegAuditAction.Builder	setAuditParameter1(@NotNull java.lang.String auditParameter1)
@NotNull OrderAuditTypesDef.OrderLegAuditAction.Builder	setAuditParameter2(@NotNull java.lang.String auditParameter2)
@NotNull OrderAuditTypesDef.OrderLegAuditAction.Builder	setAuditParameter3(@NotNull java.lang.String auditParameter3)
@NotNull OrderAuditTypesDef.OrderLegAuditAction.Builder	setAuditParameter4(@NotNull java.lang.String auditParameter4)
@NotNull OrderAuditTypesDef.OrderLegAuditAction.Builder	setAuditParameter5(@NotNull java.lang.String auditParameter5)
@NotNull OrderAuditTypesDef.OrderLegAuditAction.Builder	setOrderID(@NotNull java.lang.String orderID)
@NotNull OrderAuditTypesDef.OrderLegAuditAction.Builder	setOrderStatus(@NotNull java.lang.String orderStatus)
@NotNull OrderAuditTypesDef.OrderLegAuditAction.Builder	setVersion(int version)
@NotNull OrderAuditTypesDef.OrderLegAuditAction.Builder	setVersion(@NotNull java.lang.String version)
@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 OrderAuditTypesDef.OrderLegAuditAction.Builder addField(@NotNull
                                                                        @NotNull java.lang.String key,
                                                                        @NotNull
                                                                        @NotNull java.lang.String value)

build

@NotNull
public @NotNull OrderAuditTypesDef.OrderLegAuditAction build()

toString

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

Overrides:

toString in class java.lang.Object

setOrderID

@NotNull
public @NotNull OrderAuditTypesDef.OrderLegAuditAction.Builder setOrderID(@NotNull
                                                                          @NotNull java.lang.String orderID)

Returns:

The id of the order.

setVersion

@NotNull
public @NotNull OrderAuditTypesDef.OrderLegAuditAction.Builder setVersion(int version)

Returns:

The resulting version of this leg.

setVersion

@NotNull
public @NotNull OrderAuditTypesDef.OrderLegAuditAction.Builder setVersion(@NotNull
                                                                          @NotNull java.lang.String version)

Returns:

The resulting version of this leg.

setActionDateTime

@NotNull
public @NotNull OrderAuditTypesDef.OrderLegAuditAction.Builder setActionDateTime(@NotNull
                                                                                 @NotNull java.time.Instant actionDateTime)

Returns:

actionDateTime

setActionDateTime

@NotNull
public @NotNull OrderAuditTypesDef.OrderLegAuditAction.Builder setActionDateTime(@NotNull
                                                                                 @NotNull java.lang.String actionDateTime)

Returns:

actionDateTime

setActionBy

@NotNull
public @NotNull OrderAuditTypesDef.OrderLegAuditAction.Builder setActionBy(@NotNull
                                                                           @NotNull java.lang.String actionBy)

Returns:

Which user triggered the action to occur.

setOrderStatus

@NotNull
public @NotNull OrderAuditTypesDef.OrderLegAuditAction.Builder setOrderStatus(@NotNull
                                                                              @NotNull java.lang.String orderStatus)

Returns:

Caplin supported statuses are [PENDING-ACCEPT, PENDING-ACTIVATION, ACTIVE, PARENT-ACTIVE, PENDING-DEACTIVATION, DEACTIVATED, EXPIRED, COMPLETED, REJECTED, PENDING-CANCEL, CANCELLED, CANCELLED-BY-PARTNER]

setActionCode

@NotNull
public @NotNull OrderAuditTypesDef.OrderLegAuditAction.Builder setActionCode(int actionCode)

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.

setActionCode

@NotNull
public @NotNull OrderAuditTypesDef.OrderLegAuditAction.Builder setActionCode(@NotNull
                                                                             @NotNull java.lang.String actionCode)

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.

setAuditParameter1

@NotNull
public @NotNull OrderAuditTypesDef.OrderLegAuditAction.Builder setAuditParameter1(@NotNull
                                                                                  @NotNull java.lang.String auditParameter1)

Returns:

Parameter to be placed into the translated action reason.

setAuditParameter2

@NotNull
public @NotNull OrderAuditTypesDef.OrderLegAuditAction.Builder setAuditParameter2(@NotNull
                                                                                  @NotNull java.lang.String auditParameter2)

Returns:

Parameter to be placed into the translated action reason.

setAuditParameter3

@NotNull
public @NotNull OrderAuditTypesDef.OrderLegAuditAction.Builder setAuditParameter3(@NotNull
                                                                                  @NotNull java.lang.String auditParameter3)

Returns:

Parameter to be placed into the translated action reason.

setAuditParameter4

@NotNull
public @NotNull OrderAuditTypesDef.OrderLegAuditAction.Builder setAuditParameter4(@NotNull
                                                                                  @NotNull java.lang.String auditParameter4)

Returns:

Parameter to be placed into the translated action reason.

setAuditParameter5

@NotNull
public @NotNull OrderAuditTypesDef.OrderLegAuditAction.Builder setAuditParameter5(@NotNull
                                                                                  @NotNull java.lang.String auditParameter5)

Returns:

Parameter to be placed into the translated action reason.