io.sphere.sdk.states.commands.StateDeleteCommand Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of commercetools-models Show documentation

There is a newer version: 2.16.0

/*
This class has been generated by class io.sphere.sdk.annotations.processors.DeleteCommandEndpointAnnotationProcessor
induced by the annotation io.sphere.sdk.annotations.HasDeleteCommand.
in the source class io.sphere.sdk.states.State.
To render this class the handlebars template 'commands/deleteCommandInterface.hbs' has been used.
*/
package io.sphere.sdk.states.commands;

import io.sphere.sdk.commands.DeleteCommand;
import io.sphere.sdk.expansion.MetaModelReferenceExpansionDsl;
import io.sphere.sdk.models.Versioned;
import io.sphere.sdk.states.State;
import io.sphere.sdk.states.expansion.StateExpansionModel;

import static io.sphere.sdk.client.SphereRequestUtils.urlEncode;

/**
Deletes a state.

    
        {@include.example io.sphere.sdk.states.commands.StateDeleteCommandIntegrationTest#execution() }
    

@see State
 */
public interface StateDeleteCommand extends MetaModelReferenceExpansionDsl>, DeleteCommand {

    /**
        Creates a command object to delete a {@link State} by ID.
        @param versioned the object to delete (so directly a {@link State}) or just the version/ID information of it
        @return delete command
     */
    static StateDeleteCommand of(final Versioned versioned) {
        return new StateDeleteCommandImpl(versioned,false);
    }

    


    /**
        Creates a command object to delete a {@link State} by its key.
        @param key the key of the State to delete, see {@link State#getKey()}
        @param version `the current version of the State, see {@link State#getVersion()}
        @return delete command
    */
    static StateDeleteCommand ofKey(final String key, final Long version) {
        final Versioned versioned = Versioned.of("key=" + urlEncode(key), version);//hack for simple reuse
        return of(versioned);
    }

   

    /**
        Creates a command object to delete a {@link State} by its id.
        @param id the id of the State to delete, see {@link State#getId()}
        @param version `the current version of the State, see {@link State#getVersion()}
        @return delete command
    */
    static StateDeleteCommand ofId(final String id, final Long version) {
        final Versioned versioned = Versioned.of("id=" + urlEncode(id), version);//hack for simple reuse
        return of(versioned);
    }

   

}