Package com.commercetools.api.models.payment_method

Class PaymentMethodDraftBuilder

java.lang.Object

com.commercetools.api.models.payment_method.PaymentMethodDraftBuilder

All Implemented Interfaces:

Builder<PaymentMethodDraft>

public class PaymentMethodDraftBuilder
extends Object
implements Builder<PaymentMethodDraft>

PaymentMethodDraftBuilder Example to create an instance using the builder pattern

     PaymentMethodDraft paymentMethodDraft = PaymentMethodDraft.builder()
             .build()
 

Constructor Summary

Constructors

Constructor	Description
PaymentMethodDraftBuilder()

Method Summary

Modifier and Type	Method	Description
PaymentMethodDraftBuilder	_default(Boolean _default)	Set to true if the PaymentMethod should be the default.
PaymentMethodDraft	build()	builds PaymentMethodDraft with checking for non-null required values
PaymentMethodDraft	buildUnchecked()	builds PaymentMethodDraft without checking for non-null required values
PaymentMethodDraftBuilder	businessUnit(BusinessUnitResourceIdentifier businessUnit)	Reference to a BusinessUnit the PaymentMethod should belong to.
PaymentMethodDraftBuilder	businessUnit(Function<BusinessUnitResourceIdentifierBuilder,BusinessUnitResourceIdentifierBuilder> builder)	Reference to a BusinessUnit the PaymentMethod should belong to.
PaymentMethodDraftBuilder	custom(CustomFieldsDraft custom)	Custom Fields for the PaymentMethod.
PaymentMethodDraftBuilder	custom(Function<CustomFieldsDraftBuilder,CustomFieldsDraftBuilder> builder)	Custom Fields for the PaymentMethod.
PaymentMethodDraftBuilder	customer(CustomerResourceIdentifier customer)	Reference to a Customer the PaymentMethod should belong to.
PaymentMethodDraftBuilder	customer(Function<CustomerResourceIdentifierBuilder,CustomerResourceIdentifierBuilder> builder)	Reference to a Customer the PaymentMethod should belong to.
BusinessUnitResourceIdentifier	getBusinessUnit()	Reference to a BusinessUnit the PaymentMethod should belong to.
CustomFieldsDraft	getCustom()	Custom Fields for the PaymentMethod.
CustomerResourceIdentifier	getCustomer()	Reference to a Customer the PaymentMethod should belong to.
Boolean	getDefault()	Set to true if the PaymentMethod should be the default.
String	getInterfaceAccount()	Account or instance of the payment interface when multiple accounts are used (per interface).
String	getKey()	User-defined unique identifier for the PaymentMethod.
String	getMethod()	Payment method to use for the Payment—for example, a credit card or direct debit.
LocalizedString	getName()	Name of the PaymentMethod.
String	getPaymentInterface()	Payment service that processes the Payment—for example, a PSP.
PaymentMethodStatus	getPaymentMethodStatus()	Status of the PaymentMethod.
PaymentMethodToken	getToken()	Tokenized representation of the PaymentMethod used by the payment interface.
PaymentMethodDraftBuilder	interfaceAccount(String interfaceAccount)	Account or instance of the payment interface when multiple accounts are used (per interface).
PaymentMethodDraftBuilder	key(String key)	User-defined unique identifier for the PaymentMethod.
PaymentMethodDraftBuilder	method(String method)	Payment method to use for the Payment—for example, a credit card or direct debit.
PaymentMethodDraftBuilder	name(LocalizedString name)	Name of the PaymentMethod.
PaymentMethodDraftBuilder	name(Function<LocalizedStringBuilder,LocalizedStringBuilder> builder)	Name of the PaymentMethod.
static PaymentMethodDraftBuilder	of()	factory method for an instance of PaymentMethodDraftBuilder
static PaymentMethodDraftBuilder	of(PaymentMethodDraft template)	create builder for PaymentMethodDraft instance
PaymentMethodDraftBuilder	paymentInterface(String paymentInterface)	Payment service that processes the Payment—for example, a PSP.
PaymentMethodDraftBuilder	paymentMethodStatus(PaymentMethodStatus paymentMethodStatus)	Status of the PaymentMethod.
PaymentMethodDraftBuilder	token(PaymentMethodToken token)	Tokenized representation of the PaymentMethod used by the payment interface.
PaymentMethodDraftBuilder	token(Function<PaymentMethodTokenBuilder,PaymentMethodTokenBuilder> builder)	Tokenized representation of the PaymentMethod used by the payment interface.
PaymentMethodDraftBuilder	withBusinessUnit(Function<BusinessUnitResourceIdentifierBuilder,BusinessUnitResourceIdentifier> builder)	Reference to a BusinessUnit the PaymentMethod should belong to.
PaymentMethodDraftBuilder	withCustom(Function<CustomFieldsDraftBuilder,CustomFieldsDraft> builder)	Custom Fields for the PaymentMethod.
PaymentMethodDraftBuilder	withCustomer(Function<CustomerResourceIdentifierBuilder,CustomerResourceIdentifier> builder)	Reference to a Customer the PaymentMethod should belong to.
PaymentMethodDraftBuilder	withName(Function<LocalizedStringBuilder,LocalizedString> builder)	Name of the PaymentMethod.
PaymentMethodDraftBuilder	withToken(Function<PaymentMethodTokenBuilder,PaymentMethodToken> builder)	Tokenized representation of the PaymentMethod used by the payment interface.

Methods inherited from class java.lang.Object

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

Constructor Details

PaymentMethodDraftBuilder

public PaymentMethodDraftBuilder()

Method Details

key

public PaymentMethodDraftBuilder key(@Nullable
 String key)

User-defined unique identifier for the PaymentMethod.

Parameters:

key - value to be set

Returns:

Builder

name

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

Name of the PaymentMethod.

Parameters:

builder - function to build the name value

Returns:

Builder

withName

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

Name of the PaymentMethod.

Parameters:

builder - function to build the name value

Returns:

Builder

name

public PaymentMethodDraftBuilder name(@Nullable
 LocalizedString name)

Name of the PaymentMethod.

Parameters:

name - value to be set

Returns:

Builder

customer

public PaymentMethodDraftBuilder customer(Function<CustomerResourceIdentifierBuilder,CustomerResourceIdentifierBuilder> builder)

Reference to a Customer the PaymentMethod should belong to.

If businessUnit is set, the Customer must be an Associate of the Business Unit.

Parameters:

builder - function to build the customer value

Returns:

Builder

withCustomer

public PaymentMethodDraftBuilder withCustomer(Function<CustomerResourceIdentifierBuilder,CustomerResourceIdentifier> builder)

Reference to a Customer the PaymentMethod should belong to.

If businessUnit is set, the Customer must be an Associate of the Business Unit.

Parameters:

builder - function to build the customer value

Returns:

Builder

customer

public PaymentMethodDraftBuilder customer(@Nullable
 CustomerResourceIdentifier customer)

Reference to a Customer the PaymentMethod should belong to.

If businessUnit is set, the Customer must be an Associate of the Business Unit.

Parameters:

customer - value to be set

Returns:

Builder

businessUnit

public PaymentMethodDraftBuilder businessUnit(Function<BusinessUnitResourceIdentifierBuilder,BusinessUnitResourceIdentifierBuilder> builder)

Reference to a BusinessUnit the PaymentMethod should belong to.

Only available for B2B-enabled Projects.

Parameters:

builder - function to build the businessUnit value

Returns:

Builder

withBusinessUnit

public PaymentMethodDraftBuilder withBusinessUnit(Function<BusinessUnitResourceIdentifierBuilder,BusinessUnitResourceIdentifier> builder)

Reference to a BusinessUnit the PaymentMethod should belong to.

Only available for B2B-enabled Projects.

Parameters:

builder - function to build the businessUnit value

Returns:

Builder

businessUnit

public PaymentMethodDraftBuilder businessUnit(@Nullable
 BusinessUnitResourceIdentifier businessUnit)

Reference to a BusinessUnit the PaymentMethod should belong to.

Only available for B2B-enabled Projects.

Parameters:

businessUnit - value to be set

Returns:

Builder

method

public PaymentMethodDraftBuilder method(@Nullable
 String method)

Payment method to use for the Payment—for example, a credit card or direct debit.

Parameters:

method - value to be set

Returns:

Builder

paymentInterface

public PaymentMethodDraftBuilder paymentInterface(@Nullable
 String paymentInterface)

Payment service that processes the Payment—for example, a PSP.

Parameters:

paymentInterface - value to be set

Returns:

Builder

interfaceAccount

public PaymentMethodDraftBuilder interfaceAccount(@Nullable
 String interfaceAccount)

Account or instance of the payment interface when multiple accounts are used (per interface).

Parameters:

interfaceAccount - value to be set

Returns:

Builder

token

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

Tokenized representation of the PaymentMethod used by the payment interface.

Parameters:

builder - function to build the token value

Returns:

Builder

withToken

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

Tokenized representation of the PaymentMethod used by the payment interface.

Parameters:

builder - function to build the token value

Returns:

Builder

token

public PaymentMethodDraftBuilder token(@Nullable
 PaymentMethodToken token)

Tokenized representation of the PaymentMethod used by the payment interface.

Parameters:

token - value to be set

Returns:

Builder

paymentMethodStatus

public PaymentMethodDraftBuilder paymentMethodStatus(@Nullable
 PaymentMethodStatus paymentMethodStatus)

Status of the PaymentMethod.

Parameters:

paymentMethodStatus - value to be set

Returns:

Builder

_default

public PaymentMethodDraftBuilder _default(@Nullable
 Boolean _default)

Set to true if the PaymentMethod should be the default.

The default applies per Customer, Business Unit, or the combination of both (Associate).

Parameters:

_default - value to be set

Returns:

Builder

custom

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

Custom Fields for the PaymentMethod.

Parameters:

builder - function to build the custom value

Returns:

Builder

withCustom

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

Custom Fields for the PaymentMethod.

Parameters:

builder - function to build the custom value

Returns:

Builder

custom

public PaymentMethodDraftBuilder custom(@Nullable
 CustomFieldsDraft custom)

Custom Fields for the PaymentMethod.

Parameters:

custom - value to be set

Returns:

Builder

getKey

@Nullable
public String getKey()

User-defined unique identifier for the PaymentMethod.

Returns:

key

getName

@Nullable
public LocalizedString getName()

Name of the PaymentMethod.

Returns:

name

getCustomer

@Nullable
public CustomerResourceIdentifier getCustomer()

Reference to a Customer the PaymentMethod should belong to.

If businessUnit is set, the Customer must be an Associate of the Business Unit.

Returns:

customer

getBusinessUnit

@Nullable
public BusinessUnitResourceIdentifier getBusinessUnit()

Reference to a BusinessUnit the PaymentMethod should belong to.

Only available for B2B-enabled Projects.

Returns:

businessUnit

getMethod

@Nullable
public String getMethod()

Payment method to use for the Payment—for example, a credit card or direct debit.

Returns:

method

getPaymentInterface

@Nullable
public String getPaymentInterface()

Payment service that processes the Payment—for example, a PSP.

Returns:

paymentInterface

getInterfaceAccount

@Nullable
public String getInterfaceAccount()

Account or instance of the payment interface when multiple accounts are used (per interface).

Returns:

interfaceAccount

getToken

@Nullable
public PaymentMethodToken getToken()

Tokenized representation of the PaymentMethod used by the payment interface.

Returns:

token

getPaymentMethodStatus

@Nullable
public PaymentMethodStatus getPaymentMethodStatus()

Status of the PaymentMethod.

Returns:

paymentMethodStatus

getDefault

@Nullable
public Boolean getDefault()

Set to true if the PaymentMethod should be the default.

The default applies per Customer, Business Unit, or the combination of both (Associate).

Returns:

default

getCustom

@Nullable
public CustomFieldsDraft getCustom()

Custom Fields for the PaymentMethod.

Returns:

custom

build

public PaymentMethodDraft build()

builds PaymentMethodDraft with checking for non-null required values

Specified by:

build in interface Builder<PaymentMethodDraft>

Returns:

PaymentMethodDraft

buildUnchecked

public PaymentMethodDraft buildUnchecked()

builds PaymentMethodDraft without checking for non-null required values

Returns:

PaymentMethodDraft

of

public static PaymentMethodDraftBuilder of()

factory method for an instance of PaymentMethodDraftBuilder

Returns:

builder

of

public static PaymentMethodDraftBuilder of(PaymentMethodDraft template)

create builder for PaymentMethodDraft instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder