Package com.caplin.generated.motif.fx.settlementinstructions

Class SettlementInstructionsPartsDef.SettlementTradeFields.Builder

java.lang.Object

com.caplin.generated.motif.fx.settlementinstructions.SettlementInstructionsPartsDef.SettlementTradeFields.Builder

Enclosing class:

SettlementInstructionsPartsDef.SettlementTradeFields

public static final class SettlementInstructionsPartsDef.SettlementTradeFields.Builder
extends Object

Method Summary

Modifier and Type	Method	Description
@NotNull SettlementInstructionsPartsDef.SettlementTradeFields.Builder	addAllPay(@NotNull Collection<SettlementInstructionsPartsDef.SettlementFields> pay)
@NotNull SettlementInstructionsPartsDef.SettlementTradeFields.Builder	addAllPayNettingComponents(@NotNull Collection<SettlementInstructionsPartsDef.NettingComponents> payNettingComponents)
@NotNull SettlementInstructionsPartsDef.SettlementTradeFields.Builder	addAllReceive(@NotNull Collection<SettlementInstructionsPartsDef.SettlementFields> receive)
@NotNull SettlementInstructionsPartsDef.SettlementTradeFields.Builder	addAllReceiveNettingComponents(@NotNull Collection<SettlementInstructionsPartsDef.NettingComponents> receiveNettingComponents)
@NotNull SettlementInstructionsPartsDef.SettlementTradeFields.Builder	addField(@NotNull String key, @NotNull String value)
@NotNull SettlementInstructionsPartsDef.SettlementTradeFields.Builder	addPay(@NotNull SettlementInstructionsPartsDef.SettlementFields pay)
@NotNull SettlementInstructionsPartsDef.SettlementTradeFields.Builder	addPayNettingComponents(@NotNull SettlementInstructionsPartsDef.NettingComponents payNettingComponents)
@NotNull SettlementInstructionsPartsDef.SettlementTradeFields.Builder	addReceive(@NotNull SettlementInstructionsPartsDef.SettlementFields receive)
@NotNull SettlementInstructionsPartsDef.SettlementTradeFields.Builder	addReceiveNettingComponents(@NotNull SettlementInstructionsPartsDef.NettingComponents receiveNettingComponents)
@NotNull SettlementInstructionsPartsDef.SettlementTradeFields	build()
@NotNull SettlementInstructionsPartsDef.SettlementTradeFields.Builder	setAffirmedBy(@NotNull String affirmedBy)
@NotNull SettlementInstructionsPartsDef.SettlementTradeFields.Builder	setAffirmedDateTime(@NotNull String affirmedDateTime)
@NotNull SettlementInstructionsPartsDef.SettlementTradeFields.Builder	setAffirmedDateTime(@NotNull Instant affirmedDateTime)
@NotNull SettlementInstructionsPartsDef.SettlementTradeFields.Builder	setCanAdHoc(boolean canAdHoc)
@NotNull SettlementInstructionsPartsDef.SettlementTradeFields.Builder	setCanAdHoc(@NotNull String canAdHoc)
@NotNull SettlementInstructionsPartsDef.SettlementTradeFields.Builder	setCanAffirm(boolean canAffirm)
@NotNull SettlementInstructionsPartsDef.SettlementTradeFields.Builder	setCanAffirm(@NotNull String canAffirm)
@NotNull SettlementInstructionsPartsDef.SettlementTradeFields.Builder	setCanAutoConfirm(boolean canAutoConfirm)
@NotNull SettlementInstructionsPartsDef.SettlementTradeFields.Builder	setCanAutoConfirm(@NotNull String canAutoConfirm)
@NotNull SettlementInstructionsPartsDef.SettlementTradeFields.Builder	setCanCancel(boolean canCancel)
@NotNull SettlementInstructionsPartsDef.SettlementTradeFields.Builder	setCanCancel(@NotNull String canCancel)
@NotNull SettlementInstructionsPartsDef.SettlementTradeFields.Builder	setCanConfirm(boolean canConfirm)
@NotNull SettlementInstructionsPartsDef.SettlementTradeFields.Builder	setCanConfirm(@NotNull String canConfirm)
@NotNull SettlementInstructionsPartsDef.SettlementTradeFields.Builder	setCanDispute(boolean canDispute)
@NotNull SettlementInstructionsPartsDef.SettlementTradeFields.Builder	setCanDispute(@NotNull String canDispute)
@NotNull SettlementInstructionsPartsDef.SettlementTradeFields.Builder	setCanReplace(boolean canReplace)
@NotNull SettlementInstructionsPartsDef.SettlementTradeFields.Builder	setCanReplace(@NotNull String canReplace)
@NotNull SettlementInstructionsPartsDef.SettlementTradeFields.Builder	setCanUnconfirm(boolean canUnconfirm)
@NotNull SettlementInstructionsPartsDef.SettlementTradeFields.Builder	setCanUnconfirm(@NotNull String canUnconfirm)
@NotNull SettlementInstructionsPartsDef.SettlementTradeFields.Builder	setConfirmedBy(@NotNull String confirmedBy)
@NotNull SettlementInstructionsPartsDef.SettlementTradeFields.Builder	setConfirmedDateTime(@NotNull String confirmedDateTime)
@NotNull SettlementInstructionsPartsDef.SettlementTradeFields.Builder	setConfirmedDateTime(@NotNull Instant confirmedDateTime)
@NotNull SettlementInstructionsPartsDef.SettlementTradeFields.Builder	setIsPayNetted(boolean isPayNetted)
@NotNull SettlementInstructionsPartsDef.SettlementTradeFields.Builder	setIsPayNetted(@NotNull String isPayNetted)
@NotNull SettlementInstructionsPartsDef.SettlementTradeFields.Builder	setIsPayNettingRequired(boolean isPayNettingRequired)
@NotNull SettlementInstructionsPartsDef.SettlementTradeFields.Builder	setIsPayNettingRequired(@NotNull String isPayNettingRequired)
@NotNull SettlementInstructionsPartsDef.SettlementTradeFields.Builder	setIsPaySplit(boolean isPaySplit)
@NotNull SettlementInstructionsPartsDef.SettlementTradeFields.Builder	setIsPaySplit(@NotNull String isPaySplit)
@NotNull SettlementInstructionsPartsDef.SettlementTradeFields.Builder	setIsReceiveNetted(boolean isReceiveNetted)
@NotNull SettlementInstructionsPartsDef.SettlementTradeFields.Builder	setIsReceiveNetted(@NotNull String isReceiveNetted)
@NotNull SettlementInstructionsPartsDef.SettlementTradeFields.Builder	setIsReceiveNettingRequired(boolean isReceiveNettingRequired)
@NotNull SettlementInstructionsPartsDef.SettlementTradeFields.Builder	setIsReceiveNettingRequired(@NotNull String isReceiveNettingRequired)
@NotNull SettlementInstructionsPartsDef.SettlementTradeFields.Builder	setIsReceiveSplit(boolean isReceiveSplit)
@NotNull SettlementInstructionsPartsDef.SettlementTradeFields.Builder	setIsReceiveSplit(@NotNull String isReceiveSplit)
@NotNull SettlementInstructionsPartsDef.SettlementTradeFields.Builder	setNextActionDeadline(@NotNull String nextActionDeadline)
@NotNull SettlementInstructionsPartsDef.SettlementTradeFields.Builder	setNextActionDeadline(@NotNull Instant nextActionDeadline)
@NotNull SettlementInstructionsPartsDef.SettlementTradeFields.Builder	setNextActionDeadlineDisplayTimezone(@NotNull String nextActionDeadlineDisplayTimezone)
@NotNull SettlementInstructionsPartsDef.SettlementTradeFields.Builder	setPay(@NotNull SettlementInstructionsPartsDef.SettlementFields pay, int id)
@NotNull SettlementInstructionsPartsDef.SettlementTradeFields.Builder	setPayNettingComponents(@NotNull SettlementInstructionsPartsDef.NettingComponents payNettingComponents, int id)
@NotNull SettlementInstructionsPartsDef.SettlementTradeFields.Builder	setReceive(@NotNull SettlementInstructionsPartsDef.SettlementFields receive, int id)
@NotNull SettlementInstructionsPartsDef.SettlementTradeFields.Builder	setReceiveNettingComponents(@NotNull SettlementInstructionsPartsDef.NettingComponents receiveNettingComponents, int id)
@NotNull SettlementInstructionsPartsDef.SettlementTradeFields.Builder	setSettlementStatus(@NotNull String settlementStatus)
@NotNull 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 SettlementInstructionsPartsDef.SettlementTradeFields.Builder addField(@NotNull
                                                                                      @NotNull String key,
                                                                                      @NotNull
                                                                                      @NotNull String value)

build

@NotNull
public @NotNull SettlementInstructionsPartsDef.SettlementTradeFields build()

toString

@NotNull
public @NotNull String toString()

Overrides:

toString in class Object

setCanAffirm

@NotNull
public @NotNull SettlementInstructionsPartsDef.SettlementTradeFields.Builder setCanAffirm(boolean canAffirm)

Returns:

Ability to Affirm the Trade Details are as agreed.

setCanAffirm

@NotNull
public @NotNull SettlementInstructionsPartsDef.SettlementTradeFields.Builder setCanAffirm(@NotNull
                                                                                          @NotNull String canAffirm)

Returns:

Ability to Affirm the Trade Details are as agreed.

setCanConfirm

@NotNull
public @NotNull SettlementInstructionsPartsDef.SettlementTradeFields.Builder setCanConfirm(boolean canConfirm)

Returns:

Ability to Confirm the Settlement Details are now final.

setCanConfirm

@NotNull
public @NotNull SettlementInstructionsPartsDef.SettlementTradeFields.Builder setCanConfirm(@NotNull
                                                                                           @NotNull String canConfirm)

Returns:

Ability to Confirm the Settlement Details are now final.

setCanAdHoc

@NotNull
public @NotNull SettlementInstructionsPartsDef.SettlementTradeFields.Builder setCanAdHoc(boolean canAdHoc)

Returns:

Can confirm adhoc settlement instructions for a trade.

setCanAdHoc

@NotNull
public @NotNull SettlementInstructionsPartsDef.SettlementTradeFields.Builder setCanAdHoc(@NotNull
                                                                                         @NotNull String canAdHoc)

Returns:

Can confirm adhoc settlement instructions for a trade.

setCanDispute

@NotNull
public @NotNull SettlementInstructionsPartsDef.SettlementTradeFields.Builder setCanDispute(boolean canDispute)

Returns:

Ability to Dispute the details of a trade, if for example something is wrong about it.

setCanDispute

@NotNull
public @NotNull SettlementInstructionsPartsDef.SettlementTradeFields.Builder setCanDispute(@NotNull
                                                                                           @NotNull String canDispute)

Returns:

Ability to Dispute the details of a trade, if for example something is wrong about it.

setCanCancel

@NotNull
public @NotNull SettlementInstructionsPartsDef.SettlementTradeFields.Builder setCanCancel(boolean canCancel)

Returns:

Ability to Cancel a trade, for example if a mistake was made.

setCanCancel

@NotNull
public @NotNull SettlementInstructionsPartsDef.SettlementTradeFields.Builder setCanCancel(@NotNull
                                                                                          @NotNull String canCancel)

Returns:

Ability to Cancel a trade, for example if a mistake was made.

setCanReplace

@NotNull
public @NotNull SettlementInstructionsPartsDef.SettlementTradeFields.Builder setCanReplace(boolean canReplace)

Returns:

Ability to mark a deal as amended, meaning that it has been replaced by a corrected deal.

setCanReplace

@NotNull
public @NotNull SettlementInstructionsPartsDef.SettlementTradeFields.Builder setCanReplace(@NotNull
                                                                                           @NotNull String canReplace)

Returns:

Ability to mark a deal as amended, meaning that it has been replaced by a corrected deal.

setCanAutoConfirm

@NotNull
public @NotNull SettlementInstructionsPartsDef.SettlementTradeFields.Builder setCanAutoConfirm(boolean canAutoConfirm)

Returns:

Ability to Mark that the deal was Confirmed by the Bank, rather than by the client.

setCanAutoConfirm

@NotNull
public @NotNull SettlementInstructionsPartsDef.SettlementTradeFields.Builder setCanAutoConfirm(@NotNull
                                                                                               @NotNull String canAutoConfirm)

Returns:

Ability to Mark that the deal was Confirmed by the Bank, rather than by the client.

setCanUnconfirm

@NotNull
public @NotNull SettlementInstructionsPartsDef.SettlementTradeFields.Builder setCanUnconfirm(boolean canUnconfirm)

Returns:

Ability to move the deal back to a Pending state.

setCanUnconfirm

@NotNull
public @NotNull SettlementInstructionsPartsDef.SettlementTradeFields.Builder setCanUnconfirm(@NotNull
                                                                                             @NotNull String canUnconfirm)

Returns:

Ability to move the deal back to a Pending state.

setSettlementStatus

@NotNull
public @NotNull SettlementInstructionsPartsDef.SettlementTradeFields.Builder setSettlementStatus(@NotNull
                                                                                                 @NotNull String settlementStatus)

Returns:

Caplin supported statuses are [PENDING, AFFIRMED, CONFIRMED, DISPUTED, CANCELLED, REPLACED, AUTO_CONFIRMED, OVERDUE, REJECTED]

setNextActionDeadline

@NotNull
public @NotNull SettlementInstructionsPartsDef.SettlementTradeFields.Builder setNextActionDeadline(@NotNull
                                                                                                   @NotNull Instant nextActionDeadline)

Parameters:

nextActionDeadline - e.g. 2018-03-16T07:25:16+00:00

Returns:

The deadline for a user to perform a trade's next action in ISO-8601 format

setNextActionDeadline

@NotNull
public @NotNull SettlementInstructionsPartsDef.SettlementTradeFields.Builder setNextActionDeadline(@NotNull
                                                                                                   @NotNull String nextActionDeadline)

Parameters:

nextActionDeadline - e.g. 2018-03-16T07:25:16+00:00

Returns:

The deadline for a user to perform a trade's next action in ISO-8601 format

setNextActionDeadlineDisplayTimezone

@NotNull
public @NotNull SettlementInstructionsPartsDef.SettlementTradeFields.Builder setNextActionDeadlineDisplayTimezone(@NotNull
                                                                                                                  @NotNull String nextActionDeadlineDisplayTimezone)

Parameters:

nextActionDeadlineDisplayTimezone - e.g. America/New_York

Returns:

The timezone for the NextActionDeadline field in the form Area/Location

setAffirmedBy

@NotNull
public @NotNull SettlementInstructionsPartsDef.SettlementTradeFields.Builder setAffirmedBy(@NotNull
                                                                                           @NotNull String affirmedBy)

Returns:

The name of the user who affirmed a trade.

setAffirmedDateTime

@NotNull
public @NotNull SettlementInstructionsPartsDef.SettlementTradeFields.Builder setAffirmedDateTime(@NotNull
                                                                                                 @NotNull Instant affirmedDateTime)

Parameters:

affirmedDateTime - e.g. 2018-03-16T07:25:16+00:00

Returns:

The time at which a trade was affirmed in ISO-8601 format

setAffirmedDateTime

@NotNull
public @NotNull SettlementInstructionsPartsDef.SettlementTradeFields.Builder setAffirmedDateTime(@NotNull
                                                                                                 @NotNull String affirmedDateTime)

Parameters:

affirmedDateTime - e.g. 2018-03-16T07:25:16+00:00

Returns:

The time at which a trade was affirmed in ISO-8601 format

setConfirmedBy

@NotNull
public @NotNull SettlementInstructionsPartsDef.SettlementTradeFields.Builder setConfirmedBy(@NotNull
                                                                                            @NotNull String confirmedBy)

Returns:

The name of the user who confirmed a trade.

setConfirmedDateTime

@NotNull
public @NotNull SettlementInstructionsPartsDef.SettlementTradeFields.Builder setConfirmedDateTime(@NotNull
                                                                                                  @NotNull Instant confirmedDateTime)

Parameters:

confirmedDateTime - e.g. 2018-03-16T07:25:16+00:00

Returns:

The time at which a trade was confirmed in ISO-8601 format

setConfirmedDateTime

@NotNull
public @NotNull SettlementInstructionsPartsDef.SettlementTradeFields.Builder setConfirmedDateTime(@NotNull
                                                                                                  @NotNull String confirmedDateTime)

Parameters:

confirmedDateTime - e.g. 2018-03-16T07:25:16+00:00

Returns:

The time at which a trade was confirmed in ISO-8601 format

setIsPayNetted

@NotNull
public @NotNull SettlementInstructionsPartsDef.SettlementTradeFields.Builder setIsPayNetted(boolean isPayNetted)

Returns:

Denotes whether the pay side of a trade has been netted.

setIsPayNetted

@NotNull
public @NotNull SettlementInstructionsPartsDef.SettlementTradeFields.Builder setIsPayNetted(@NotNull
                                                                                            @NotNull String isPayNetted)

Returns:

Denotes whether the pay side of a trade has been netted.

setIsReceiveNetted

@NotNull
public @NotNull SettlementInstructionsPartsDef.SettlementTradeFields.Builder setIsReceiveNetted(boolean isReceiveNetted)

Returns:

Denotes whether the receive side of a trade has been netted.

setIsReceiveNetted

@NotNull
public @NotNull SettlementInstructionsPartsDef.SettlementTradeFields.Builder setIsReceiveNetted(@NotNull
                                                                                                @NotNull String isReceiveNetted)

Returns:

Denotes whether the receive side of a trade has been netted.

setIsPayNettingRequired

@NotNull
public @NotNull SettlementInstructionsPartsDef.SettlementTradeFields.Builder setIsPayNettingRequired(boolean isPayNettingRequired)

Returns:

Denotes whether the pay side of a trade requires netting.

setIsPayNettingRequired

@NotNull
public @NotNull SettlementInstructionsPartsDef.SettlementTradeFields.Builder setIsPayNettingRequired(@NotNull
                                                                                                     @NotNull String isPayNettingRequired)

Returns:

Denotes whether the pay side of a trade requires netting.

setIsReceiveNettingRequired

@NotNull
public @NotNull SettlementInstructionsPartsDef.SettlementTradeFields.Builder setIsReceiveNettingRequired(boolean isReceiveNettingRequired)

Returns:

Denotes whether the receive side of a trade requires netting.

setIsReceiveNettingRequired

@NotNull
public @NotNull SettlementInstructionsPartsDef.SettlementTradeFields.Builder setIsReceiveNettingRequired(@NotNull
                                                                                                         @NotNull String isReceiveNettingRequired)

Returns:

Denotes whether the receive side of a trade requires netting.

setIsPaySplit

@NotNull
public @NotNull SettlementInstructionsPartsDef.SettlementTradeFields.Builder setIsPaySplit(boolean isPaySplit)

Returns:

Denotes whether the pay side of a trade has been split.

setIsPaySplit

@NotNull
public @NotNull SettlementInstructionsPartsDef.SettlementTradeFields.Builder setIsPaySplit(@NotNull
                                                                                           @NotNull String isPaySplit)

Returns:

Denotes whether the pay side of a trade has been split.

setIsReceiveSplit

@NotNull
public @NotNull SettlementInstructionsPartsDef.SettlementTradeFields.Builder setIsReceiveSplit(boolean isReceiveSplit)

Returns:

Denotes whether the receive side of a trade has been split.

setIsReceiveSplit

@NotNull
public @NotNull SettlementInstructionsPartsDef.SettlementTradeFields.Builder setIsReceiveSplit(@NotNull
                                                                                               @NotNull String isReceiveSplit)

Returns:

Denotes whether the receive side of a trade has been split.

addPay

@NotNull
public @NotNull SettlementInstructionsPartsDef.SettlementTradeFields.Builder addPay(@NotNull
                                                                                    @NotNull SettlementInstructionsPartsDef.SettlementFields pay)

Returns:

pay

setPay

@NotNull
public @NotNull SettlementInstructionsPartsDef.SettlementTradeFields.Builder setPay(@NotNull
                                                                                    @NotNull SettlementInstructionsPartsDef.SettlementFields pay,
                                                                                    int id)

Returns:

pay

addAllPay

@NotNull
public @NotNull SettlementInstructionsPartsDef.SettlementTradeFields.Builder addAllPay(@NotNull
                                                                                       @NotNull Collection<SettlementInstructionsPartsDef.SettlementFields> pay)

Returns:

pay

addReceive

@NotNull
public @NotNull SettlementInstructionsPartsDef.SettlementTradeFields.Builder addReceive(@NotNull
                                                                                        @NotNull SettlementInstructionsPartsDef.SettlementFields receive)

Returns:

receive

setReceive

@NotNull
public @NotNull SettlementInstructionsPartsDef.SettlementTradeFields.Builder setReceive(@NotNull
                                                                                        @NotNull SettlementInstructionsPartsDef.SettlementFields receive,
                                                                                        int id)

Returns:

receive

addAllReceive

@NotNull
public @NotNull SettlementInstructionsPartsDef.SettlementTradeFields.Builder addAllReceive(@NotNull
                                                                                           @NotNull Collection<SettlementInstructionsPartsDef.SettlementFields> receive)

Returns:

receive

addPayNettingComponents

@NotNull
public @NotNull SettlementInstructionsPartsDef.SettlementTradeFields.Builder addPayNettingComponents(@NotNull
                                                                                                     @NotNull SettlementInstructionsPartsDef.NettingComponents payNettingComponents)

Returns:

payNettingComponents

setPayNettingComponents

@NotNull
public @NotNull SettlementInstructionsPartsDef.SettlementTradeFields.Builder setPayNettingComponents(@NotNull
                                                                                                     @NotNull SettlementInstructionsPartsDef.NettingComponents payNettingComponents,
                                                                                                     int id)

Returns:

payNettingComponents

addAllPayNettingComponents

@NotNull
public @NotNull SettlementInstructionsPartsDef.SettlementTradeFields.Builder addAllPayNettingComponents(@NotNull
                                                                                                        @NotNull Collection<SettlementInstructionsPartsDef.NettingComponents> payNettingComponents)

Returns:

payNettingComponents

addReceiveNettingComponents

@NotNull
public @NotNull SettlementInstructionsPartsDef.SettlementTradeFields.Builder addReceiveNettingComponents(@NotNull
                                                                                                         @NotNull SettlementInstructionsPartsDef.NettingComponents receiveNettingComponents)

Returns:

receiveNettingComponents

setReceiveNettingComponents

@NotNull
public @NotNull SettlementInstructionsPartsDef.SettlementTradeFields.Builder setReceiveNettingComponents(@NotNull
                                                                                                         @NotNull SettlementInstructionsPartsDef.NettingComponents receiveNettingComponents,
                                                                                                         int id)

Returns:

receiveNettingComponents

addAllReceiveNettingComponents

@NotNull
public @NotNull SettlementInstructionsPartsDef.SettlementTradeFields.Builder addAllReceiveNettingComponents(@NotNull
                                                                                                            @NotNull Collection<SettlementInstructionsPartsDef.NettingComponents> receiveNettingComponents)

Returns:

receiveNettingComponents