io.sphere.sdk.payments.commands

Interface PaymentDeleteCommand

All Superinterfaces:

Command<Payment>, DeleteCommand<Payment>, ExpansionPathContainer<Payment>, MetaModelReferenceExpansionDsl<Payment,PaymentDeleteCommand,PaymentExpansionModel<Payment>>, ReferenceExpansionDsl<Payment,PaymentDeleteCommand>, ReferenceExpansionSupport<Payment>, SphereRequest<Payment>

public interface PaymentDeleteCommand
extends MetaModelReferenceExpansionDsl<Payment,PaymentDeleteCommand,PaymentExpansionModel<Payment>>, DeleteCommand<Payment>

Command object to delete a Payment.

final PaymentDraft paymentDraft = PaymentDraftBuilder.of(EURO_20).build();
final Payment payment = client().executeBlocking(PaymentCreateCommand.of(paymentDraft));
client().executeBlocking(PaymentDeleteCommand.of(payment));

final Payment loadedPayment = client().executeBlocking(PaymentByIdGet.of(payment));

assertThat(loadedPayment).isNull();
See the test code.

See Also:

Payment

Method Summary

Modifier and Type	Method and Description
static PaymentDeleteCommand	of(Versioned<Payment> versioned) Creates a command object to delete a Payment by ID.
static PaymentDeleteCommand	of(Versioned<Payment> versioned, boolean eraseData) Creates a command object to delete a Payment by ID.
static PaymentDeleteCommand	ofKey(String key, Long version) Creates a command object to delete a Payment by its key.
static PaymentDeleteCommand	ofKey(String key, Long version, boolean eraseData) Creates a command object to delete a Payment by its key.

Methods inherited from interface io.sphere.sdk.expansion.MetaModelReferenceExpansionDsl

plusExpansionPaths, withExpansionPaths

Methods inherited from interface io.sphere.sdk.expansion.ReferenceExpansionDsl

plusExpansionPaths, plusExpansionPaths, plusExpansionPaths, plusExpansionPaths, withExpansionPaths, withExpansionPaths, withExpansionPaths, withExpansionPaths

Methods inherited from interface io.sphere.sdk.expansion.ReferenceExpansionSupport

expansionPaths

Methods inherited from interface io.sphere.sdk.client.SphereRequest

canDeserialize, deserialize, httpRequestIntent

Method Detail

of

static PaymentDeleteCommand of(Versioned<Payment> versioned)

Creates a command object to delete a Payment by ID.

Parameters:

versioned - the object to delete (so directly a Payment) or just the version/ID information of it

Returns:

delete command

of

static PaymentDeleteCommand of(Versioned<Payment> versioned,
                               boolean eraseData)

Creates a command object to delete a Payment by ID.

Parameters:

versioned - the object to delete (so directly a Payment) or just the version/ID information of it

eraseData - If set to true, Composable Commerce guarantees that all personal data related to the particular object, including invisible data, is erased, in compliance with the GDPR.

Returns:

delete command

ofKey

static PaymentDeleteCommand ofKey(String key,
                                  Long version)

Creates a command object to delete a Payment by its key.

Parameters:

key - the key of the Payment to delete, see Payment.getKey()

version - `the current version of the Payment, see Resource.getVersion()

Returns:

delete command

ofKey

static PaymentDeleteCommand ofKey(String key,
                                  Long version,
                                  boolean eraseData)

Creates a command object to delete a Payment by its key.

Parameters:

key - the key of the Payment to delete, see Payment.getKey()

version - the current version of the Payment, see Resource.getVersion()

eraseData - If set to true, Composable Commerce guarantees that all personal data related to the particular object, including invisible data, is erased, in compliance with the GDPR.

Returns:

delete command