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

Class SettlementInstructionsPartsDef.SettlementFields.Builder

java.lang.Object

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

Enclosing class:

SettlementInstructionsPartsDef.SettlementFields

public static final class SettlementInstructionsPartsDef.SettlementFields.Builder
extends Object

Method Summary

Modifier and Type	Method	Description
@NotNull SettlementInstructionsPartsDef.SettlementFields.Builder	addField(@NotNull String key, @NotNull String value)
@NotNull SettlementInstructionsPartsDef.SettlementFields	build()
@NotNull SettlementInstructionsPartsDef.SettlementFields.Builder	setBankAccount(@NotNull String bankAccount)
@NotNull SettlementInstructionsPartsDef.SettlementFields.Builder	setBankAddress1(@NotNull String bankAddress1)
@NotNull SettlementInstructionsPartsDef.SettlementFields.Builder	setBankAddress2(@NotNull String bankAddress2)
@NotNull SettlementInstructionsPartsDef.SettlementFields.Builder	setBankAddress3(@NotNull String bankAddress3)
@NotNull SettlementInstructionsPartsDef.SettlementFields.Builder	setBankName(@NotNull String bankName)
@NotNull SettlementInstructionsPartsDef.SettlementFields.Builder	setBankSwift(@NotNull String bankSwift)
@NotNull SettlementInstructionsPartsDef.SettlementFields.Builder	setIndividualAccount(@NotNull String individualAccount)
@NotNull SettlementInstructionsPartsDef.SettlementFields.Builder	setIndividualAddress1(@NotNull String individualAddress1)
@NotNull SettlementInstructionsPartsDef.SettlementFields.Builder	setIndividualAddress2(@NotNull String individualAddress2)
@NotNull SettlementInstructionsPartsDef.SettlementFields.Builder	setIndividualName(@NotNull String individualName)
@NotNull SettlementInstructionsPartsDef.SettlementFields.Builder	setIndividualSwift(@NotNull String individualSwift)
@NotNull SettlementInstructionsPartsDef.SettlementFields.Builder	setIsDefaultSettlementInstruction(boolean isDefaultSettlementInstruction)
@NotNull SettlementInstructionsPartsDef.SettlementFields.Builder	setIsDefaultSettlementInstruction(@NotNull String isDefaultSettlementInstruction)
@NotNull SettlementInstructionsPartsDef.SettlementFields.Builder	setNettingStatus(@NotNull String nettingStatus)
@NotNull SettlementInstructionsPartsDef.SettlementFields.Builder	setSettlementAmount(@NotNull String settlementAmount)
@NotNull SettlementInstructionsPartsDef.SettlementFields.Builder	setSettlementAmount(@NotNull BigDecimal settlementAmount)
@NotNull SettlementInstructionsPartsDef.SettlementFields.Builder	setSettlementCurrency(@NotNull String settlementCurrency)
@NotNull SettlementInstructionsPartsDef.SettlementFields.Builder	setSettlementDetailsLine1(@NotNull String settlementDetailsLine1)
@NotNull SettlementInstructionsPartsDef.SettlementFields.Builder	setSettlementDetailsLine2(@NotNull String settlementDetailsLine2)
@NotNull SettlementInstructionsPartsDef.SettlementFields.Builder	setSettlementDetailsLine3(@NotNull String settlementDetailsLine3)
@NotNull SettlementInstructionsPartsDef.SettlementFields.Builder	setSettlementDetailsLine4(@NotNull String settlementDetailsLine4)
@NotNull SettlementInstructionsPartsDef.SettlementFields.Builder	setSettlementDirection(@NotNull String settlementDirection)
@NotNull SettlementInstructionsPartsDef.SettlementFields.Builder	setSettlementDisplayName(@NotNull String settlementDisplayName)
@NotNull SettlementInstructionsPartsDef.SettlementFields.Builder	setSettlementId(@NotNull String settlementId)
@NotNull SettlementInstructionsPartsDef.SettlementFields.Builder	setSettlementInstructionType(@NotNull String settlementInstructionType)
@NotNull SettlementInstructionsPartsDef.SettlementFields.Builder	setSettlementStatus(@NotNull String settlementStatus)
@NotNull SettlementInstructionsPartsDef.SettlementFields.Builder	setSplitComponentId(@NotNull String splitComponentId)
@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.SettlementFields.Builder addField(@NotNull
                                                                                 @NotNull String key,
                                                                                 @NotNull
                                                                                 @NotNull String value)

build

@NotNull
public @NotNull SettlementInstructionsPartsDef.SettlementFields build()

toString

@NotNull
public @NotNull String toString()

Overrides:

toString in class Object

setSettlementId

@NotNull
public @NotNull SettlementInstructionsPartsDef.SettlementFields.Builder setSettlementId(@NotNull
                                                                                        @NotNull String settlementId)

Returns:

The identifier for the settlement instruction.

setSettlementCurrency

@NotNull
public @NotNull SettlementInstructionsPartsDef.SettlementFields.Builder setSettlementCurrency(@NotNull
                                                                                              @NotNull String settlementCurrency)

Parameters:

settlementCurrency - e.g. GBP

Returns:

A currency for of settlement instruction

setSettlementAmount

@NotNull
public @NotNull SettlementInstructionsPartsDef.SettlementFields.Builder setSettlementAmount(@NotNull
                                                                                            @NotNull BigDecimal settlementAmount)

Returns:

The amount of a settlement

setSettlementAmount

@NotNull
public @NotNull SettlementInstructionsPartsDef.SettlementFields.Builder setSettlementAmount(@NotNull
                                                                                            @NotNull String settlementAmount)

Returns:

The amount of a settlement

setSettlementDirection

@NotNull
public @NotNull SettlementInstructionsPartsDef.SettlementFields.Builder setSettlementDirection(@NotNull
                                                                                               @NotNull String settlementDirection)

Returns:

The direction in which the settlement details refer to, supported directions are: PAY, RECEIVE, BOTH

setIsDefaultSettlementInstruction

@NotNull
public @NotNull SettlementInstructionsPartsDef.SettlementFields.Builder setIsDefaultSettlementInstruction(boolean isDefaultSettlementInstruction)

Returns:

Is this the default settlement instruction for this currency

setIsDefaultSettlementInstruction

@NotNull
public @NotNull SettlementInstructionsPartsDef.SettlementFields.Builder setIsDefaultSettlementInstruction(@NotNull
                                                                                                          @NotNull String isDefaultSettlementInstruction)

Returns:

Is this the default settlement instruction for this currency

setSettlementInstructionType

@NotNull
public @NotNull SettlementInstructionsPartsDef.SettlementFields.Builder setSettlementInstructionType(@NotNull
                                                                                                     @NotNull String settlementInstructionType)

Parameters:

settlementInstructionType - e.g. EXISTING

Returns:

The type of settlement instruction attached to a trade. Supported types are [EXISTING, ADHOC, NONE]

setSettlementDisplayName

@NotNull
public @NotNull SettlementInstructionsPartsDef.SettlementFields.Builder setSettlementDisplayName(@NotNull
                                                                                                 @NotNull String settlementDisplayName)

Parameters:

settlementDisplayName - e.g. [CCY] Account 1

Returns:

The name of the settlement instruction. This field can be omitted.

setSettlementStatus

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

Returns:

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

setBankAccount

@NotNull
public @NotNull SettlementInstructionsPartsDef.SettlementFields.Builder setBankAccount(@NotNull
                                                                                       @NotNull String bankAccount)

Parameters:

bankAccount - e.g. 12345678

Returns:

The account number of the bank

setBankSwift

@NotNull
public @NotNull SettlementInstructionsPartsDef.SettlementFields.Builder setBankSwift(@NotNull
                                                                                     @NotNull String bankSwift)

Parameters:

bankSwift - e.g. CAP123

Returns:

The BIC of the bank

setBankName

@NotNull
public @NotNull SettlementInstructionsPartsDef.SettlementFields.Builder setBankName(@NotNull
                                                                                    @NotNull String bankName)

Parameters:

bankName - e.g. Bank Of Caplin

Returns:

The name of the bank

setBankAddress1

@NotNull
public @NotNull SettlementInstructionsPartsDef.SettlementFields.Builder setBankAddress1(@NotNull
                                                                                        @NotNull String bankAddress1)

Parameters:

bankAddress1 - e.g. 12 Capitol

Returns:

The first line of the bank's address

setBankAddress2

@NotNull
public @NotNull SettlementInstructionsPartsDef.SettlementFields.Builder setBankAddress2(@NotNull
                                                                                        @NotNull String bankAddress2)

Parameters:

bankAddress2 - e.g. The City

Returns:

The second line of the bank's address

setBankAddress3

@NotNull
public @NotNull SettlementInstructionsPartsDef.SettlementFields.Builder setBankAddress3(@NotNull
                                                                                        @NotNull String bankAddress3)

Parameters:

bankAddress3 - e.g. London

Returns:

The third line of the bank's address

setIndividualAccount

@NotNull
public @NotNull SettlementInstructionsPartsDef.SettlementFields.Builder setIndividualAccount(@NotNull
                                                                                             @NotNull String individualAccount)

Parameters:

individualAccount - e.g. 87654321

Returns:

The account number of the recipient

setIndividualSwift

@NotNull
public @NotNull SettlementInstructionsPartsDef.SettlementFields.Builder setIndividualSwift(@NotNull
                                                                                           @NotNull String individualSwift)

Parameters:

individualSwift - e.g. SOLD987

Returns:

The BIC of the recipient's account

setIndividualName

@NotNull
public @NotNull SettlementInstructionsPartsDef.SettlementFields.Builder setIndividualName(@NotNull
                                                                                          @NotNull String individualName)

Parameters:

individualName - e.g. Susan Sellers

Returns:

The name of the payee or payee's bank

setIndividualAddress1

@NotNull
public @NotNull SettlementInstructionsPartsDef.SettlementFields.Builder setIndividualAddress1(@NotNull
                                                                                              @NotNull String individualAddress1)

Parameters:

individualAddress1 - e.g. 98 Lane

Returns:

The first line of the recipient

setIndividualAddress2

@NotNull
public @NotNull SettlementInstructionsPartsDef.SettlementFields.Builder setIndividualAddress2(@NotNull
                                                                                              @NotNull String individualAddress2)

Parameters:

individualAddress2 - e.g. Manchester

Returns:

The second line of the recipient

setNettingStatus

@NotNull
public @NotNull SettlementInstructionsPartsDef.SettlementFields.Builder setNettingStatus(@NotNull
                                                                                         @NotNull String nettingStatus)

Parameters:

nettingStatus - e.g. NETTED

Returns:

The status that denotes the permanent netting state of a settlement. This is required to know which settlements have been netted and which have not

setSplitComponentId

@NotNull
public @NotNull SettlementInstructionsPartsDef.SettlementFields.Builder setSplitComponentId(@NotNull
                                                                                            @NotNull String splitComponentId)

Returns:

The unique ID of a split component

setSettlementDetailsLine1

@NotNull
public @NotNull SettlementInstructionsPartsDef.SettlementFields.Builder setSettlementDetailsLine1(@NotNull
                                                                                                  @NotNull String settlementDetailsLine1)

Returns:

The first line of remittance information.

setSettlementDetailsLine2

@NotNull
public @NotNull SettlementInstructionsPartsDef.SettlementFields.Builder setSettlementDetailsLine2(@NotNull
                                                                                                  @NotNull String settlementDetailsLine2)

Returns:

The second line of remittance information.

setSettlementDetailsLine3

@NotNull
public @NotNull SettlementInstructionsPartsDef.SettlementFields.Builder setSettlementDetailsLine3(@NotNull
                                                                                                  @NotNull String settlementDetailsLine3)

Returns:

The third line of remittance information.

setSettlementDetailsLine4

@NotNull
public @NotNull SettlementInstructionsPartsDef.SettlementFields.Builder setSettlementDetailsLine4(@NotNull
                                                                                                  @NotNull String settlementDetailsLine4)

Returns:

The fourth line of remittance information.