Package com.commercetools.api.models.order_edit

Class OrderEditDraftBuilder

java.lang.Object

com.commercetools.api.models.order_edit.OrderEditDraftBuilder

All Implemented Interfaces:

Builder<OrderEditDraft>

public class OrderEditDraftBuilder
extends Object
implements Builder<OrderEditDraft>

OrderEditDraftBuilder Example to create an instance using the builder pattern

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

Constructor Summary

Constructors

Constructor	Description
OrderEditDraftBuilder()

Method Summary

Modifier and Type	Method	Description
OrderEditDraft	build()	builds OrderEditDraft with checking for non-null required values
OrderEditDraft	buildUnchecked()	builds OrderEditDraft without checking for non-null required values
OrderEditDraftBuilder	comment(String comment)	User-defined description regarding the Order Edit.
OrderEditDraftBuilder	custom(CustomFieldsDraft custom)	Custom Fields for the Order Edit.
OrderEditDraftBuilder	custom(Function<CustomFieldsDraftBuilder,CustomFieldsDraftBuilder> builder)	Custom Fields for the Order Edit.
OrderEditDraftBuilder	dryRun(Boolean dryRun)	Set to true if you want to peview the edited Order first without persisting it (dry run).
String	getComment()	User-defined description regarding the Order Edit.
CustomFieldsDraft	getCustom()	Custom Fields for the Order Edit.
Boolean	getDryRun()	Set to true if you want to peview the edited Order first without persisting it (dry run).
String	getKey()	User-defined unique identifier for the Order Edit.
OrderReference	getResource()	Reference to the Order updated with this edit.
List<StagedOrderUpdateAction>	getStagedActions()	Update actions to apply to the Order referenced in resource.
OrderEditDraftBuilder	key(String key)	User-defined unique identifier for the Order Edit.
static OrderEditDraftBuilder	of()	factory method for an instance of OrderEditDraftBuilder
static OrderEditDraftBuilder	of(OrderEditDraft template)	create builder for OrderEditDraft instance
OrderEditDraftBuilder	plusStagedActions(StagedOrderUpdateAction... stagedActions)	Update actions to apply to the Order referenced in resource.
OrderEditDraftBuilder	plusStagedActions(Function<StagedOrderUpdateActionBuilder,Builder<? extends StagedOrderUpdateAction>> builder)	Update actions to apply to the Order referenced in resource.
OrderEditDraftBuilder	resource(OrderReference resource)	Reference to the Order updated with this edit.
OrderEditDraftBuilder	resource(Function<OrderReferenceBuilder,OrderReferenceBuilder> builder)	Reference to the Order updated with this edit.
OrderEditDraftBuilder	stagedActions(StagedOrderUpdateAction... stagedActions)	Update actions to apply to the Order referenced in resource.
OrderEditDraftBuilder	stagedActions(List<StagedOrderUpdateAction> stagedActions)	Update actions to apply to the Order referenced in resource.
OrderEditDraftBuilder	withCustom(Function<CustomFieldsDraftBuilder,CustomFieldsDraft> builder)	Custom Fields for the Order Edit.
OrderEditDraftBuilder	withResource(Function<OrderReferenceBuilder,OrderReference> builder)	Reference to the Order updated with this edit.
OrderEditDraftBuilder	withStagedActions(Function<StagedOrderUpdateActionBuilder,Builder<? extends StagedOrderUpdateAction>> builder)	Update actions to apply to the Order referenced in resource.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

OrderEditDraftBuilder

public OrderEditDraftBuilder()

Method Details

key

public OrderEditDraftBuilder key(@Nullable
 String key)

User-defined unique identifier for the Order Edit.

Parameters:

key - value to be set

Returns:

Builder

resource

public OrderEditDraftBuilder resource(Function<OrderReferenceBuilder,OrderReferenceBuilder> builder)

Reference to the Order updated with this edit.

Parameters:

builder - function to build the resource value

Returns:

Builder

withResource

public OrderEditDraftBuilder withResource(Function<OrderReferenceBuilder,OrderReference> builder)

Reference to the Order updated with this edit.

Parameters:

builder - function to build the resource value

Returns:

Builder

resource

public OrderEditDraftBuilder resource(OrderReference resource)

Reference to the Order updated with this edit.

Parameters:

resource - value to be set

Returns:

Builder

stagedActions

public OrderEditDraftBuilder stagedActions(@Nullable
 StagedOrderUpdateAction... stagedActions)

Update actions to apply to the Order referenced in resource. Cannot be updated if the edit has been applied.

Parameters:

stagedActions - value to be set

Returns:

Builder

stagedActions

public OrderEditDraftBuilder stagedActions(@Nullable
 List<StagedOrderUpdateAction> stagedActions)

Update actions to apply to the Order referenced in resource. Cannot be updated if the edit has been applied.

Parameters:

stagedActions - value to be set

Returns:

Builder

plusStagedActions

public OrderEditDraftBuilder plusStagedActions(@Nullable
 StagedOrderUpdateAction... stagedActions)

Update actions to apply to the Order referenced in resource. Cannot be updated if the edit has been applied.

Parameters:

stagedActions - value to be set

Returns:

Builder

plusStagedActions

public OrderEditDraftBuilder plusStagedActions(Function<StagedOrderUpdateActionBuilder,Builder<? extends StagedOrderUpdateAction>> builder)

Update actions to apply to the Order referenced in resource. Cannot be updated if the edit has been applied.

Parameters:

builder - function to build the stagedActions value

Returns:

Builder

withStagedActions

public OrderEditDraftBuilder withStagedActions(Function<StagedOrderUpdateActionBuilder,Builder<? extends StagedOrderUpdateAction>> builder)

Update actions to apply to the Order referenced in resource. Cannot be updated if the edit has been applied.

Parameters:

builder - function to build the stagedActions value

Returns:

Builder

custom

public OrderEditDraftBuilder custom(Function<CustomFieldsDraftBuilder,CustomFieldsDraftBuilder> builder)

Custom Fields for the Order Edit.

Parameters:

builder - function to build the custom value

Returns:

Builder

withCustom

public OrderEditDraftBuilder withCustom(Function<CustomFieldsDraftBuilder,CustomFieldsDraft> builder)

Custom Fields for the Order Edit.

Parameters:

builder - function to build the custom value

Returns:

Builder

custom

public OrderEditDraftBuilder custom(@Nullable
 CustomFieldsDraft custom)

Custom Fields for the Order Edit.

Parameters:

custom - value to be set

Returns:

Builder

comment

public OrderEditDraftBuilder comment(@Nullable
 String comment)

User-defined description regarding the Order Edit.

Parameters:

comment - value to be set

Returns:

Builder

dryRun

public OrderEditDraftBuilder dryRun(@Nullable
 Boolean dryRun)

Set to true if you want to peview the edited Order first without persisting it (dry run). A dry run allows checking for potential errors when trying to apply the stagedActions.

Order API Extensions, if any, are also called in dry runs.

Parameters:

dryRun - value to be set

Returns:

Builder

getKey

@Nullable
public String getKey()

User-defined unique identifier for the Order Edit.

Returns:

key

getResource

public OrderReference getResource()

Reference to the Order updated with this edit.

Returns:

resource

getStagedActions

@Nullable
public List<StagedOrderUpdateAction> getStagedActions()

Update actions to apply to the Order referenced in resource. Cannot be updated if the edit has been applied.

Returns:

stagedActions

getCustom

@Nullable
public CustomFieldsDraft getCustom()

Custom Fields for the Order Edit.

Returns:

custom

getComment

@Nullable
public String getComment()

User-defined description regarding the Order Edit.

Returns:

comment

getDryRun

@Nullable
public Boolean getDryRun()

Set to true if you want to peview the edited Order first without persisting it (dry run). A dry run allows checking for potential errors when trying to apply the stagedActions.

Order API Extensions, if any, are also called in dry runs.

Returns:

dryRun

build

public OrderEditDraft build()

builds OrderEditDraft with checking for non-null required values

Specified by:

build in interface Builder<OrderEditDraft>

Returns:

OrderEditDraft

buildUnchecked

public OrderEditDraft buildUnchecked()

builds OrderEditDraft without checking for non-null required values

Returns:

OrderEditDraft

of

public static OrderEditDraftBuilder of()

factory method for an instance of OrderEditDraftBuilder

Returns:

builder

of

public static OrderEditDraftBuilder of(OrderEditDraft template)

create builder for OrderEditDraft instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder