Package com.caplin.generated.motif.commodities.invoice

Class InvoicePartsDef.CommonInvoiceFields.Builder

java.lang.Object

com.caplin.generated.motif.commodities.invoice.InvoicePartsDef.CommonInvoiceFields.Builder

Enclosing class:

InvoicePartsDef.CommonInvoiceFields

public static final class InvoicePartsDef.CommonInvoiceFields.Builder
extends Object

Method Summary

Modifier and Type	Method	Description
@NotNull InvoicePartsDef.CommonInvoiceFields.Builder	addField(@NotNull String key, @NotNull String value)
@NotNull InvoicePartsDef.CommonInvoiceFields	build()
@NotNull InvoicePartsDef.CommonInvoiceFields.Builder	setCommodity(@NotNull String commodity)
@NotNull InvoicePartsDef.CommonInvoiceFields.Builder	setCurrency(@NotNull String currency)
@NotNull InvoicePartsDef.CommonInvoiceFields.Builder	setEntityDescription(@NotNull String entityDescription)
@NotNull InvoicePartsDef.CommonInvoiceFields.Builder	setGroupID(@NotNull String groupID)
@NotNull InvoicePartsDef.CommonInvoiceFields.Builder	setInvoiceType(@NotNull String invoiceType)
@NotNull InvoicePartsDef.CommonInvoiceFields.Builder	setIssueDate(@NotNull String issueDate)
@NotNull InvoicePartsDef.CommonInvoiceFields.Builder	setNetPaymentAmount(@NotNull String netPaymentAmount)
@NotNull InvoicePartsDef.CommonInvoiceFields.Builder	setNetPaymentAmount(@NotNull BigDecimal netPaymentAmount)
@NotNull InvoicePartsDef.CommonInvoiceFields.Builder	setPaymentDate(@NotNull String paymentDate)
@NotNull InvoicePartsDef.CommonInvoiceFields.Builder	setTradingType(@NotNull String tradingType)
@NotNull String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Details

addField

@NotNull
public @NotNull InvoicePartsDef.CommonInvoiceFields.Builder addField(@NotNull
 @NotNull String key,
 @NotNull
 @NotNull String value)

build

@NotNull
public @NotNull InvoicePartsDef.CommonInvoiceFields build()

toString

@NotNull
public @NotNull String toString()

Overrides:

toString in class Object

setGroupID

@NotNull
public @NotNull InvoicePartsDef.CommonInvoiceFields.Builder setGroupID(@NotNull
 @NotNull String groupID)

Returns:

A unique identifier for this group.

setInvoiceType

@NotNull
public @NotNull InvoicePartsDef.CommonInvoiceFields.Builder setInvoiceType(@NotNull
 @NotNull String invoiceType)

Returns:

represents type of invoice, Caplin supported values are [Settlement, Premium], example=

setEntityDescription

@NotNull
public @NotNull InvoicePartsDef.CommonInvoiceFields.Builder setEntityDescription(@NotNull
 @NotNull String entityDescription)

Returns:

The entity the trade is on behalf of.

setTradingType

@NotNull
public @NotNull InvoicePartsDef.CommonInvoiceFields.Builder setTradingType(@NotNull
 @NotNull String tradingType)

Returns:

Caplin supported values are [FIXED_SWAP, BASIS_SWAP, EURO_PUT, EURO_CALL, EURO_COLLAR, EURO_3_WAY_COLLAR, EURO_CALL_SPREAD, ASIAN_CAP, ASIAN_FLOOR, ASIAN_COLLAR, ASIAN_3_WAY_COLLAR, ASIAN_CAP_SPREAD, ASIAN_FLOOR_SPREAD, SPREAD_PUT]. See the constants defined within com.caplin.motif.commodities.trading.CommoditiesTradingType for further details.

setCommodity

@NotNull
public @NotNull InvoicePartsDef.CommonInvoiceFields.Builder setCommodity(@NotNull
 @NotNull String commodity)

Returns:

The commodity of the trade.

setIssueDate

@NotNull
public @NotNull InvoicePartsDef.CommonInvoiceFields.Builder setIssueDate(@NotNull
 @NotNull String issueDate)

Returns:

What date the invoice was issued on.

setPaymentDate

@NotNull
public @NotNull InvoicePartsDef.CommonInvoiceFields.Builder setPaymentDate(@NotNull
 @NotNull String paymentDate)

Returns:

The date by when the payment needs to be done.

setNetPaymentAmount

@NotNull
public @NotNull InvoicePartsDef.CommonInvoiceFields.Builder setNetPaymentAmount(@NotNull
 @NotNull BigDecimal netPaymentAmount)

Returns:

The net amount of all the payments in an invoice.

setNetPaymentAmount

@NotNull
public @NotNull InvoicePartsDef.CommonInvoiceFields.Builder setNetPaymentAmount(@NotNull
 @NotNull String netPaymentAmount)

Returns:

The net amount of all the payments in an invoice.

setCurrency

@NotNull
public @NotNull InvoicePartsDef.CommonInvoiceFields.Builder setCurrency(@NotNull
 @NotNull String currency)

Returns:

The currency the transaction has been made in.