Package com.commercetools.api.models.order_edit

Interface StagedOrderSetShippingAddressAndCustomShippingMethodAction

All Superinterfaces:

ResourceUpdateAction<StagedOrderUpdateAction>, StagedOrderUpdateAction

All Known Implementing Classes:

StagedOrderSetShippingAddressAndCustomShippingMethodActionImpl

public interface StagedOrderSetShippingAddressAndCustomShippingMethodAction
extends StagedOrderUpdateAction

StagedOrderSetShippingAddressAndCustomShippingMethodAction Example to create an instance using the builder pattern

     StagedOrderSetShippingAddressAndCustomShippingMethodAction stagedOrderSetShippingAddressAndCustomShippingMethodAction = StagedOrderSetShippingAddressAndCustomShippingMethodAction.builder()
             .address(addressBuilder -> addressBuilder)
             .shippingMethodName("{shippingMethodName}")
             .shippingRate(shippingRateBuilder -> shippingRateBuilder)
             .build()
 

Field Summary

Fields

Modifier and Type	Field	Description
static final String	SET_SHIPPING_ADDRESS_AND_CUSTOM_SHIPPING_METHOD	discriminator value for StagedOrderSetShippingAddressAndCustomShippingMethodAction

Method Summary

Modifier and Type	Method	Description
static StagedOrderSetShippingAddressAndCustomShippingMethodActionBuilder	builder()	builder factory method for StagedOrderSetShippingAddressAndCustomShippingMethodAction
static StagedOrderSetShippingAddressAndCustomShippingMethodActionBuilder	builder(StagedOrderSetShippingAddressAndCustomShippingMethodAction template)	create builder for StagedOrderSetShippingAddressAndCustomShippingMethodAction instance
static StagedOrderSetShippingAddressAndCustomShippingMethodAction	deepCopy(StagedOrderSetShippingAddressAndCustomShippingMethodAction template)	factory method to create a deep copy of StagedOrderSetShippingAddressAndCustomShippingMethodAction
@NotNull @Valid BaseAddress	getAddress()	Polymorphic base type that represents a postal address and contact details.
@Valid ExternalTaxRateDraft	getExternalTaxRate()	Controls calculation of taxed prices for Line Items, Custom Line Items, and Shipping Methods as explained in Cart tax calculation.
@NotNull String	getShippingMethodName()
@NotNull @Valid ShippingRateDraft	getShippingRate()
@Valid TaxCategoryResourceIdentifier	getTaxCategory()	ResourceIdentifier to a TaxCategory.
static StagedOrderSetShippingAddressAndCustomShippingMethodAction	of()	factory method
static StagedOrderSetShippingAddressAndCustomShippingMethodAction	of(StagedOrderSetShippingAddressAndCustomShippingMethodAction template)	factory method to create a shallow copy StagedOrderSetShippingAddressAndCustomShippingMethodAction
void	setAddress(BaseAddress address)	Polymorphic base type that represents a postal address and contact details.
void	setExternalTaxRate(ExternalTaxRateDraft externalTaxRate)	Controls calculation of taxed prices for Line Items, Custom Line Items, and Shipping Methods as explained in Cart tax calculation.
void	setShippingMethodName(String shippingMethodName)	set shippingMethodName
void	setShippingRate(ShippingRateDraft shippingRate)	set shippingRate
void	setTaxCategory(TaxCategoryResourceIdentifier taxCategory)	ResourceIdentifier to a TaxCategory.
static com.fasterxml.jackson.core.type.TypeReference<StagedOrderSetShippingAddressAndCustomShippingMethodAction>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withStagedOrderSetShippingAddressAndCustomShippingMethodAction(Function<StagedOrderSetShippingAddressAndCustomShippingMethodAction,T> helper)	accessor map function

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

get

Methods inherited from interface com.commercetools.api.models.order.StagedOrderUpdateAction

getAction, withStagedOrderUpdateAction

Field Details

SET_SHIPPING_ADDRESS_AND_CUSTOM_SHIPPING_METHOD

static final String SET_SHIPPING_ADDRESS_AND_CUSTOM_SHIPPING_METHOD

discriminator value for StagedOrderSetShippingAddressAndCustomShippingMethodAction

See Also:

• Constant Field Values

Method Details

getAddress

@NotNull
@Valid
@NotNull @Valid BaseAddress getAddress()

Polymorphic base type that represents a postal address and contact details. Depending on the read or write action, it can be either Address or AddressDraft that only differ in the data type for the optional custom field.

Returns:

address

getShippingMethodName

@NotNull
@NotNull String getShippingMethodName()

Returns:

shippingMethodName

getShippingRate

@NotNull
@Valid
@NotNull @Valid ShippingRateDraft getShippingRate()

Returns:

shippingRate

getTaxCategory

@Valid
@Valid TaxCategoryResourceIdentifier getTaxCategory()

ResourceIdentifier to a TaxCategory.

Returns:

taxCategory

getExternalTaxRate

@Valid
@Valid ExternalTaxRateDraft getExternalTaxRate()

Controls calculation of taxed prices for Line Items, Custom Line Items, and Shipping Methods as explained in Cart tax calculation.

Returns:

externalTaxRate

setAddress

void setAddress(BaseAddress address)

Polymorphic base type that represents a postal address and contact details. Depending on the read or write action, it can be either Address or AddressDraft that only differ in the data type for the optional custom field.

Parameters:

address - value to be set

setShippingMethodName

void setShippingMethodName(String shippingMethodName)

set shippingMethodName

Parameters:

shippingMethodName - value to be set

setShippingRate

void setShippingRate(ShippingRateDraft shippingRate)

set shippingRate

Parameters:

shippingRate - value to be set

setTaxCategory

void setTaxCategory(TaxCategoryResourceIdentifier taxCategory)

ResourceIdentifier to a TaxCategory.

Parameters:

taxCategory - value to be set

setExternalTaxRate

void setExternalTaxRate(ExternalTaxRateDraft externalTaxRate)

Controls calculation of taxed prices for Line Items, Custom Line Items, and Shipping Methods as explained in Cart tax calculation.

Parameters:

externalTaxRate - value to be set

of

static StagedOrderSetShippingAddressAndCustomShippingMethodAction of()

factory method

Returns:

instance of StagedOrderSetShippingAddressAndCustomShippingMethodAction

of

static StagedOrderSetShippingAddressAndCustomShippingMethodAction of(StagedOrderSetShippingAddressAndCustomShippingMethodAction template)

factory method to create a shallow copy StagedOrderSetShippingAddressAndCustomShippingMethodAction

Parameters:

template - instance to be copied

Returns:

copy instance

deepCopy

@Nullable
static StagedOrderSetShippingAddressAndCustomShippingMethodAction deepCopy(@Nullable
 StagedOrderSetShippingAddressAndCustomShippingMethodAction template)

factory method to create a deep copy of StagedOrderSetShippingAddressAndCustomShippingMethodAction

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static StagedOrderSetShippingAddressAndCustomShippingMethodActionBuilder builder()

builder factory method for StagedOrderSetShippingAddressAndCustomShippingMethodAction

Returns:

builder

builder

static StagedOrderSetShippingAddressAndCustomShippingMethodActionBuilder builder(StagedOrderSetShippingAddressAndCustomShippingMethodAction template)

create builder for StagedOrderSetShippingAddressAndCustomShippingMethodAction instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withStagedOrderSetShippingAddressAndCustomShippingMethodAction

default <T> T withStagedOrderSetShippingAddressAndCustomShippingMethodAction(Function<StagedOrderSetShippingAddressAndCustomShippingMethodAction,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<StagedOrderSetShippingAddressAndCustomShippingMethodAction> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference