io.sphere.sdk.states.commands

Interface StateDeleteCommand

All Superinterfaces:

Command<State>, DeleteCommand<State>, ExpansionPathContainer<State>, MetaModelReferenceExpansionDsl<State,StateDeleteCommand,StateExpansionModel<State>>, ReferenceExpansionDsl<State,StateDeleteCommand>, ReferenceExpansionSupport<State>, SphereRequest<State>

public interface StateDeleteCommand
extends MetaModelReferenceExpansionDsl<State,StateDeleteCommand,StateExpansionModel<State>>, DeleteCommand<State>

Deletes a state.

StateFixtures.withState(client(), state -> {
    final State deletedState = client().executeBlocking(StateDeleteCommand.of(state));
});
See the test code.

See Also:

State

Method Summary

Modifier and Type	Method and Description
static StateDeleteCommand	of(Versioned<State> versioned) Creates a command object to delete a State by ID.
static StateDeleteCommand	ofId(String id, Long version) Creates a command object to delete a State by its id.
static StateDeleteCommand	ofKey(String key, Long version) Creates a command object to delete a State 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 StateDeleteCommand of(Versioned<State> versioned)

Creates a command object to delete a State by ID.

Parameters:

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

Returns:

delete command

ofKey

static StateDeleteCommand ofKey(String key,
                                Long version)

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

Parameters:

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

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

Returns:

delete command

ofId

static StateDeleteCommand ofId(String id,
                               Long version)

Creates a command object to delete a State by its id.

Parameters:

id - the id of the State to delete, see Resource.getId()

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

Returns:

delete command