io.sphere.sdk.payments

Class TransactionDraftDsl

java.lang.Object

io.sphere.sdk.models.Base

io.sphere.sdk.payments.TransactionDraftDsl

All Implemented Interfaces:

TransactionDraft

public final class TransactionDraftDsl
extends Base

Method Summary

Modifier and Type	Method and Description
javax.money.MonetaryAmount	getAmount()
CustomFields	getCustom()
String	getInteractionId()
TransactionState	getState() The state of this transaction.
ZonedDateTime	getTimestamp()
TransactionType	getType()
TransactionDraftBuilder	newBuilder() Creates a new builder with the values of this object.
static TransactionDraftDsl	of(TransactionDraft template) Creates a new object initialized with the fields of the template parameter.
static TransactionDraftDsl	of(TransactionType type, javax.money.MonetaryAmount amount) Creates a new object initialized with the given values.
static TransactionDraftDsl	of(TransactionType type, javax.money.MonetaryAmount amount, ZonedDateTime timestamp) Creates a new object initialized with the given values.
T	withAmount(javax.money.MonetaryAmount amount)
T	withCustom(CustomFields custom)
T	withInteractionId(String interactionId)
T	withState(TransactionState state)
T	withTimestamp(ZonedDateTime timestamp)
T	withType(TransactionType type)

Methods inherited from class io.sphere.sdk.models.Base

equals, hashCode, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

getAmount

public javax.money.MonetaryAmount getAmount()

Specified by:

getAmount in interface TransactionDraft

getCustom

@Nullable
public CustomFields getCustom()

Specified by:

getCustom in interface TransactionDraft

getInteractionId

@Nullable
public String getInteractionId()

Specified by:

getInteractionId in interface TransactionDraft

getState

@Nullable
public TransactionState getState()

Description copied from interface: TransactionDraft

The state of this transaction. If not set, currently defaults to Pending. As part of a Beta improvement initiative, we will switch the default to Initial. In the mean time, please do not depend on the default value but provide the state field explicitly.

Specified by:

getState in interface TransactionDraft

getTimestamp

@Nullable
public ZonedDateTime getTimestamp()

Specified by:

getTimestamp in interface TransactionDraft

getType

public TransactionType getType()

Specified by:

getType in interface TransactionDraft

newBuilder

public TransactionDraftBuilder newBuilder()

Creates a new builder with the values of this object.

Returns:

new builder

withAmount

public T withAmount(javax.money.MonetaryAmount amount)

withCustom

public T withCustom(@Nullable
                    CustomFields custom)

withInteractionId

public T withInteractionId(@Nullable
                           String interactionId)

withState

public T withState(@Nullable
                   TransactionState state)

withTimestamp

public T withTimestamp(@Nullable
                       ZonedDateTime timestamp)

withType

public T withType(TransactionType type)

of

public static TransactionDraftDsl of(TransactionType type,
                                     javax.money.MonetaryAmount amount)

Creates a new object initialized with the given values.

Parameters:

type - initial value for the TransactionDraft.getType() property

amount - initial value for the TransactionDraft.getAmount() property

Returns:

new object initialized with the given values

of

public static TransactionDraftDsl of(TransactionType type,
                                     javax.money.MonetaryAmount amount,
                                     @Nullable
                                     ZonedDateTime timestamp)

Creates a new object initialized with the given values.

Parameters:

type - initial value for the TransactionDraft.getType() property

amount - initial value for the TransactionDraft.getAmount() property

timestamp - initial value for the TransactionDraft.getTimestamp() property

Returns:

new object initialized with the given values

of

public static TransactionDraftDsl of(TransactionDraft template)

Creates a new object initialized with the fields of the template parameter.

Parameters:

template - the template

Returns:

a new object initialized from the template