Package com.commercetools.api.models.payment

Class PaymentSetMethodInfoActionBuilder

java.lang.Object

com.commercetools.api.models.payment.PaymentSetMethodInfoActionBuilder

All Implemented Interfaces:

Builder<PaymentSetMethodInfoAction>

public class PaymentSetMethodInfoActionBuilder
extends Object
implements Builder<PaymentSetMethodInfoAction>

PaymentSetMethodInfoActionBuilder Example to create an instance using the builder pattern

     PaymentSetMethodInfoAction paymentSetMethodInfoAction = PaymentSetMethodInfoAction.builder()
             .build()
 

Constructor Summary

Constructors

Constructor	Description
PaymentSetMethodInfoActionBuilder()

Method Summary

Modifier and Type	Method	Description
PaymentSetMethodInfoAction	build()	builds PaymentSetMethodInfoAction with checking for non-null required values
PaymentSetMethodInfoAction	buildUnchecked()	builds PaymentSetMethodInfoAction without checking for non-null required values
PaymentSetMethodInfoActionBuilder	custom(CustomFieldsDraft custom)	Custom Fields for the PaymentMethodInfo.
PaymentSetMethodInfoActionBuilder	custom(Function<CustomFieldsDraftBuilder,CustomFieldsDraftBuilder> builder)	Custom Fields for the PaymentMethodInfo.
CustomFieldsDraft	getCustom()	Custom Fields for the PaymentMethodInfo.
String	getInterfaceAccount()	Account or instance of the payment interface when multiple accounts are used (per interface).
String	getMethod()	Payment method to use—for example, a credit card or direct debit.
LocalizedString	getName()	Name of the Payment Method.
String	getPaymentInterface()	Payment service that processes the Payment—for example, a PSP.
PaymentMethodToken	getToken()	Tokenized payment method information of the Payment Method.
PaymentSetMethodInfoActionBuilder	interfaceAccount(String interfaceAccount)	Account or instance of the payment interface when multiple accounts are used (per interface).
PaymentSetMethodInfoActionBuilder	method(String method)	Payment method to use—for example, a credit card or direct debit.
PaymentSetMethodInfoActionBuilder	name(LocalizedString name)	Name of the Payment Method.
PaymentSetMethodInfoActionBuilder	name(Function<LocalizedStringBuilder,LocalizedStringBuilder> builder)	Name of the Payment Method.
static PaymentSetMethodInfoActionBuilder	of()	factory method for an instance of PaymentSetMethodInfoActionBuilder
static PaymentSetMethodInfoActionBuilder	of(PaymentSetMethodInfoAction template)	create builder for PaymentSetMethodInfoAction instance
PaymentSetMethodInfoActionBuilder	paymentInterface(String paymentInterface)	Payment service that processes the Payment—for example, a PSP.
PaymentSetMethodInfoActionBuilder	token(PaymentMethodToken token)	Tokenized payment method information of the Payment Method.
PaymentSetMethodInfoActionBuilder	token(Function<PaymentMethodTokenBuilder,PaymentMethodTokenBuilder> builder)	Tokenized payment method information of the Payment Method.
PaymentSetMethodInfoActionBuilder	withCustom(Function<CustomFieldsDraftBuilder,CustomFieldsDraft> builder)	Custom Fields for the PaymentMethodInfo.
PaymentSetMethodInfoActionBuilder	withName(Function<LocalizedStringBuilder,LocalizedString> builder)	Name of the Payment Method.
PaymentSetMethodInfoActionBuilder	withToken(Function<PaymentMethodTokenBuilder,PaymentMethodToken> builder)	Tokenized payment method information of the Payment Method.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

PaymentSetMethodInfoActionBuilder

public PaymentSetMethodInfoActionBuilder()

Method Details

paymentInterface

public PaymentSetMethodInfoActionBuilder paymentInterface(@Nullable
 String paymentInterface)

Payment service that processes the Payment—for example, a PSP. The combination of paymentInterface and the interfaceId of a Payment must be unique. The value cannot be modified after it is set.

Setting this field is equivalent to the setMethodInfoInterface action and will generate the PaymentMethodInfoInterfaceSet Message.

Parameters:

paymentInterface - value to be set

Returns:

Builder

method

public PaymentSetMethodInfoActionBuilder method(@Nullable
 String method)

Payment method to use—for example, a credit card or direct debit. If empty, any existing value will be removed.

Setting this field is equivalent to the setMethodInfoMethod action and will generate the PaymentMethodInfoMethodSet Message.

Parameters:

method - value to be set

Returns:

Builder

name

public PaymentSetMethodInfoActionBuilder name(Function<LocalizedStringBuilder,LocalizedStringBuilder> builder)

Name of the Payment Method. If empty, any existing value will be removed.

Setting this field is equivalent to the setMethodInfoName action and will generate the PaymentMethodInfoNameSet Message.

Parameters:

builder - function to build the name value

Returns:

Builder

withName

public PaymentSetMethodInfoActionBuilder withName(Function<LocalizedStringBuilder,LocalizedString> builder)

Name of the Payment Method. If empty, any existing value will be removed.

Setting this field is equivalent to the setMethodInfoName action and will generate the PaymentMethodInfoNameSet Message.

Parameters:

builder - function to build the name value

Returns:

Builder

name

public PaymentSetMethodInfoActionBuilder name(@Nullable
 LocalizedString name)

Name of the Payment Method. If empty, any existing value will be removed.

Setting this field is equivalent to the setMethodInfoName action and will generate the PaymentMethodInfoNameSet Message.

Parameters:

name - value to be set

Returns:

Builder

token

public PaymentSetMethodInfoActionBuilder token(Function<PaymentMethodTokenBuilder,PaymentMethodTokenBuilder> builder)

Tokenized payment method information of the Payment Method. If empty, any existing value will be removed.

Setting this field is equivalent to the setMethodInfoToken action and will generate the PaymentMethodInfoTokenSet Message.

Parameters:

builder - function to build the token value

Returns:

Builder

withToken

public PaymentSetMethodInfoActionBuilder withToken(Function<PaymentMethodTokenBuilder,PaymentMethodToken> builder)

Tokenized payment method information of the Payment Method. If empty, any existing value will be removed.

Setting this field is equivalent to the setMethodInfoToken action and will generate the PaymentMethodInfoTokenSet Message.

Parameters:

builder - function to build the token value

Returns:

Builder

token

public PaymentSetMethodInfoActionBuilder token(@Nullable
 PaymentMethodToken token)

Tokenized payment method information of the Payment Method. If empty, any existing value will be removed.

Setting this field is equivalent to the setMethodInfoToken action and will generate the PaymentMethodInfoTokenSet Message.

Parameters:

token - value to be set

Returns:

Builder

interfaceAccount

public PaymentSetMethodInfoActionBuilder interfaceAccount(@Nullable
 String interfaceAccount)

Account or instance of the payment interface when multiple accounts are used (per interface). If empty, any existing value will be removed.

Setting this field is equivalent to the setMethodInfoInterfaceAccount action and will generate the PaymentMethodInfoInterfaceAccountSet Message.

Parameters:

interfaceAccount - value to be set

Returns:

Builder

custom

public PaymentSetMethodInfoActionBuilder custom(Function<CustomFieldsDraftBuilder,CustomFieldsDraftBuilder> builder)

Custom Fields for the PaymentMethodInfo. If not provided, any existing Custom Fields will be removed, including the Custom Type.

Setting this field is equivalent to the setMethodInfoCustomType and setMethodInfoCustomField actions, and will generate the following Messages:

• Adding or updating a Custom Type on a Payment Method Info generates the PaymentMethodInfoCustomTypeSet Message, removing one generates the PaymentMethodInfoCustomTypeRemoved Message.
• Adding a Custom Field to a Payment generates the PaymentMethodInfoCustomFieldAdded Message, removing one generates the PaymentMethodInfoCustomFieldRemoved Message, and updating an existing one generates the PaymentMethodInfoCustomFieldChanged Message.

Parameters:

builder - function to build the custom value

Returns:

Builder

withCustom

public PaymentSetMethodInfoActionBuilder withCustom(Function<CustomFieldsDraftBuilder,CustomFieldsDraft> builder)

Custom Fields for the PaymentMethodInfo. If not provided, any existing Custom Fields will be removed, including the Custom Type.

Setting this field is equivalent to the setMethodInfoCustomType and setMethodInfoCustomField actions, and will generate the following Messages:

• Adding or updating a Custom Type on a Payment Method Info generates the PaymentMethodInfoCustomTypeSet Message, removing one generates the PaymentMethodInfoCustomTypeRemoved Message.
• Adding a Custom Field to a Payment generates the PaymentMethodInfoCustomFieldAdded Message, removing one generates the PaymentMethodInfoCustomFieldRemoved Message, and updating an existing one generates the PaymentMethodInfoCustomFieldChanged Message.

Parameters:

builder - function to build the custom value

Returns:

Builder

custom

public PaymentSetMethodInfoActionBuilder custom(@Nullable
 CustomFieldsDraft custom)

Custom Fields for the PaymentMethodInfo. If not provided, any existing Custom Fields will be removed, including the Custom Type.

Setting this field is equivalent to the setMethodInfoCustomType and setMethodInfoCustomField actions, and will generate the following Messages:

• Adding or updating a Custom Type on a Payment Method Info generates the PaymentMethodInfoCustomTypeSet Message, removing one generates the PaymentMethodInfoCustomTypeRemoved Message.
• Adding a Custom Field to a Payment generates the PaymentMethodInfoCustomFieldAdded Message, removing one generates the PaymentMethodInfoCustomFieldRemoved Message, and updating an existing one generates the PaymentMethodInfoCustomFieldChanged Message.

Parameters:

custom - value to be set

Returns:

Builder

getPaymentInterface

@Nullable
public String getPaymentInterface()

Payment service that processes the Payment—for example, a PSP. The combination of paymentInterface and the interfaceId of a Payment must be unique. The value cannot be modified after it is set.

Setting this field is equivalent to the setMethodInfoInterface action and will generate the PaymentMethodInfoInterfaceSet Message.

Returns:

paymentInterface

getMethod

@Nullable
public String getMethod()

Payment method to use—for example, a credit card or direct debit. If empty, any existing value will be removed.

Setting this field is equivalent to the setMethodInfoMethod action and will generate the PaymentMethodInfoMethodSet Message.

Returns:

method

getName

@Nullable
public LocalizedString getName()

Name of the Payment Method. If empty, any existing value will be removed.

Setting this field is equivalent to the setMethodInfoName action and will generate the PaymentMethodInfoNameSet Message.

Returns:

name

getToken

@Nullable
public PaymentMethodToken getToken()

Tokenized payment method information of the Payment Method. If empty, any existing value will be removed.

Setting this field is equivalent to the setMethodInfoToken action and will generate the PaymentMethodInfoTokenSet Message.

Returns:

token

getInterfaceAccount

@Nullable
public String getInterfaceAccount()

Account or instance of the payment interface when multiple accounts are used (per interface). If empty, any existing value will be removed.

Setting this field is equivalent to the setMethodInfoInterfaceAccount action and will generate the PaymentMethodInfoInterfaceAccountSet Message.

Returns:

interfaceAccount

getCustom

@Nullable
public CustomFieldsDraft getCustom()

Custom Fields for the PaymentMethodInfo. If not provided, any existing Custom Fields will be removed, including the Custom Type.

Setting this field is equivalent to the setMethodInfoCustomType and setMethodInfoCustomField actions, and will generate the following Messages:

• Adding or updating a Custom Type on a Payment Method Info generates the PaymentMethodInfoCustomTypeSet Message, removing one generates the PaymentMethodInfoCustomTypeRemoved Message.
• Adding a Custom Field to a Payment generates the PaymentMethodInfoCustomFieldAdded Message, removing one generates the PaymentMethodInfoCustomFieldRemoved Message, and updating an existing one generates the PaymentMethodInfoCustomFieldChanged Message.

Returns:

custom

build

public PaymentSetMethodInfoAction build()

builds PaymentSetMethodInfoAction with checking for non-null required values

Specified by:

build in interface Builder<PaymentSetMethodInfoAction>

Returns:

PaymentSetMethodInfoAction

buildUnchecked

public PaymentSetMethodInfoAction buildUnchecked()

builds PaymentSetMethodInfoAction without checking for non-null required values

Returns:

PaymentSetMethodInfoAction

of

public static PaymentSetMethodInfoActionBuilder of()

factory method for an instance of PaymentSetMethodInfoActionBuilder

Returns:

builder

of

public static PaymentSetMethodInfoActionBuilder of(PaymentSetMethodInfoAction template)

create builder for PaymentSetMethodInfoAction instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder