Package com.commercetools.api.models.order_edit

Interface OrderEditDraft

All Superinterfaces:

CustomizableDraft<OrderEditDraft>, io.vrap.rmf.base.client.Draft<OrderEditDraft>, WithKey

All Known Implementing Classes:

OrderEditDraftImpl

public interface OrderEditDraft
extends CustomizableDraft<OrderEditDraft>, WithKey, io.vrap.rmf.base.client.Draft<OrderEditDraft>

OrderEditDraft Example to create an instance using the builder pattern

     OrderEditDraft orderEditDraft = OrderEditDraft.builder()
             .resource(resourceBuilder -> resourceBuilder)
             .build()
 

Method Summary

Modifier and Type	Method	Description
static OrderEditDraftBuilder	builder()	builder factory method for OrderEditDraft
static OrderEditDraftBuilder	builder(OrderEditDraft template)	create builder for OrderEditDraft instance
static OrderEditDraft	deepCopy(OrderEditDraft template)	factory method to create a deep copy of OrderEditDraft
String	getComment()	This field can be used to add additional textual information regarding the edit.
@Valid CustomFieldsDraft	getCustom()	The custom fields.
Boolean	getDryRun()	When set to true the edit is applied on the Order without persisting it.
String	getKey()	User-defined unique identifier for the OrderEdit.
@NotNull @Valid OrderReference	getResource()	The order to be updated with this edit.
@Valid List<StagedOrderUpdateAction>	getStagedActions()	The actions to apply to resource.
static OrderEditDraft	of()	factory method
static OrderEditDraft	of(OrderEditDraft template)	factory method to create a shallow copy OrderEditDraft
void	setComment(String comment)	This field can be used to add additional textual information regarding the edit.
void	setCustom(CustomFieldsDraft custom)	The custom fields.
void	setDryRun(Boolean dryRun)	When set to true the edit is applied on the Order without persisting it.
void	setKey(String key)	User-defined unique identifier for the OrderEdit.
void	setResource(OrderReference resource)	The order to be updated with this edit.
void	setStagedActions(StagedOrderUpdateAction... stagedActions)	The actions to apply to resource.
void	setStagedActions(List<StagedOrderUpdateAction> stagedActions)	The actions to apply to resource.
static com.fasterxml.jackson.core.type.TypeReference<OrderEditDraft>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withOrderEditDraft(Function<OrderEditDraft,T> helper)	accessor map function

Methods inherited from interface com.commercetools.api.models.CustomizableDraft

unwrapCustomizableDraft

Method Details

getKey

String getKey()

User-defined unique identifier for the OrderEdit.

Specified by:

getKey in interface WithKey

Returns:

key

getResource

@NotNull
@Valid
@NotNull @Valid OrderReference getResource()

The order to be updated with this edit.

Returns:

resource

getStagedActions

@Valid
@Valid List<StagedOrderUpdateAction> getStagedActions()

The actions to apply to resource.

Returns:

stagedActions

getCustom

@Valid
@Valid CustomFieldsDraft getCustom()

The custom fields.

Specified by:

getCustom in interface CustomizableDraft<OrderEditDraft>

Returns:

custom

getComment

String getComment()

This field can be used to add additional textual information regarding the edit.

Returns:

comment

getDryRun

Boolean getDryRun()

When set to true the edit is applied on the Order without persisting it.

Returns:

dryRun

setKey

void setKey(String key)

User-defined unique identifier for the OrderEdit.

Parameters:

key - value to be set

setResource

void setResource(OrderReference resource)

The order to be updated with this edit.

Parameters:

resource - value to be set

setStagedActions

void setStagedActions(StagedOrderUpdateAction... stagedActions)

The actions to apply to resource.

Parameters:

stagedActions - values to be set

setStagedActions

void setStagedActions(List<StagedOrderUpdateAction> stagedActions)

The actions to apply to resource.

Parameters:

stagedActions - values to be set

setCustom

void setCustom(CustomFieldsDraft custom)

The custom fields.

Specified by:

setCustom in interface CustomizableDraft<OrderEditDraft>

Parameters:

custom - value to be set

setComment

void setComment(String comment)

This field can be used to add additional textual information regarding the edit.

Parameters:

comment - value to be set

setDryRun

void setDryRun(Boolean dryRun)

When set to true the edit is applied on the Order without persisting it.

Parameters:

dryRun - value to be set

of

static OrderEditDraft of()

factory method

Returns:

instance of OrderEditDraft

of

static OrderEditDraft of(OrderEditDraft template)

factory method to create a shallow copy OrderEditDraft

Parameters:

template - instance to be copied

Returns:

copy instance

deepCopy

@Nullable
static OrderEditDraft deepCopy(@Nullable
 OrderEditDraft template)

factory method to create a deep copy of OrderEditDraft

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static OrderEditDraftBuilder builder()

builder factory method for OrderEditDraft

Returns:

builder

builder

static OrderEditDraftBuilder builder(OrderEditDraft template)

create builder for OrderEditDraft instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withOrderEditDraft

default <T> T withOrderEditDraft(Function<OrderEditDraft,T> helper)

accessor map function

Type Parameters:

T - mapped type

Parameters:

helper - function to map the object

Returns:

mapped value

typeReference

static com.fasterxml.jackson.core.type.TypeReference<OrderEditDraft> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference