Package com.commercetools.api.models.shipping_method

Class ShippingMethodDraftBuilder

java.lang.Object

com.commercetools.api.models.shipping_method.ShippingMethodDraftBuilder

All Implemented Interfaces:

Builder<ShippingMethodDraft>

public class ShippingMethodDraftBuilder
extends Object
implements Builder<ShippingMethodDraft>

ShippingMethodDraftBuilder Example to create an instance using the builder pattern

     ShippingMethodDraft shippingMethodDraft = ShippingMethodDraft.builder()
             .name("{name}")
             .taxCategory(taxCategoryBuilder -> taxCategoryBuilder)
             .plusZoneRates(zoneRatesBuilder -> zoneRatesBuilder)
             .isDefault(true)
             .build()
 

Constructor Summary

Constructors

Constructor	Description
ShippingMethodDraftBuilder()

Method Summary

Modifier and Type	Method	Description
ShippingMethodDraftBuilder	active(Boolean active)	If set to true, the ShippingMethod can be used during the creation or update of a Cart or Order.
ShippingMethodDraftBuilder	addZoneRates(Function<ZoneRateDraftBuilder,ZoneRateDraft> builder)	Defines ShippingRates (prices) for specific zones.
ShippingMethodDraft	build()	builds ShippingMethodDraft with checking for non-null required values
ShippingMethodDraft	buildUnchecked()	builds ShippingMethodDraft without checking for non-null required values
ShippingMethodDraftBuilder	custom(CustomFieldsDraft custom)	Custom Fields for the ShippingMethod.
ShippingMethodDraftBuilder	custom(Function<CustomFieldsDraftBuilder,CustomFieldsDraftBuilder> builder)	Custom Fields for the ShippingMethod.
ShippingMethodDraftBuilder	description(String description)	Deprecated.
Boolean	getActive()	If set to true, the ShippingMethod can be used during the creation or update of a Cart or Order.
CustomFieldsDraft	getCustom()	Custom Fields for the ShippingMethod.
String	getDescription()	Deprecated.
Boolean	getIsDefault()	If set to true, the ShippingMethod will be the Project's default ShippingMethod.
String	getKey()	User-defined unique identifier for the ShippingMethod.
LocalizedString	getLocalizedDescription()	Localized description of the ShippingMethod.
LocalizedString	getLocalizedName()	Localized name of the ShippingMethod.
String	getName()	Unique name for the ShippingMethod within a Project.
String	getPredicate()	Valid Cart predicate to select a ShippingMethod for a Cart.
TaxCategoryResourceIdentifier	getTaxCategory()	TaxCategory for all ZoneRates of the ShippingMethod.
List<ZoneRateDraft>	getZoneRates()	Defines ShippingRates (prices) for specific zones.
ShippingMethodDraftBuilder	isDefault(Boolean isDefault)	If set to true, the ShippingMethod will be the Project's default ShippingMethod.
ShippingMethodDraftBuilder	key(String key)	User-defined unique identifier for the ShippingMethod.
ShippingMethodDraftBuilder	localizedDescription(LocalizedString localizedDescription)	Localized description of the ShippingMethod.
ShippingMethodDraftBuilder	localizedDescription(Function<LocalizedStringBuilder,LocalizedStringBuilder> builder)	Localized description of the ShippingMethod.
ShippingMethodDraftBuilder	localizedName(LocalizedString localizedName)	Localized name of the ShippingMethod.
ShippingMethodDraftBuilder	localizedName(Function<LocalizedStringBuilder,LocalizedStringBuilder> builder)	Localized name of the ShippingMethod.
ShippingMethodDraftBuilder	name(String name)	Unique name for the ShippingMethod within a Project.
static ShippingMethodDraftBuilder	of()	factory method for an instance of ShippingMethodDraftBuilder
static ShippingMethodDraftBuilder	of(ShippingMethodDraft template)	create builder for ShippingMethodDraft instance
ShippingMethodDraftBuilder	plusZoneRates(ZoneRateDraft... zoneRates)	Defines ShippingRates (prices) for specific zones.
ShippingMethodDraftBuilder	plusZoneRates(Function<ZoneRateDraftBuilder,ZoneRateDraftBuilder> builder)	Defines ShippingRates (prices) for specific zones.
ShippingMethodDraftBuilder	predicate(String predicate)	Valid Cart predicate to select a ShippingMethod for a Cart.
ShippingMethodDraftBuilder	setZoneRates(Function<ZoneRateDraftBuilder,ZoneRateDraft> builder)	Defines ShippingRates (prices) for specific zones.
ShippingMethodDraftBuilder	taxCategory(TaxCategoryResourceIdentifier taxCategory)	TaxCategory for all ZoneRates of the ShippingMethod.
ShippingMethodDraftBuilder	taxCategory(Function<TaxCategoryResourceIdentifierBuilder,TaxCategoryResourceIdentifierBuilder> builder)	TaxCategory for all ZoneRates of the ShippingMethod.
ShippingMethodDraftBuilder	withCustom(Function<CustomFieldsDraftBuilder,CustomFieldsDraft> builder)	Custom Fields for the ShippingMethod.
ShippingMethodDraftBuilder	withLocalizedDescription(Function<LocalizedStringBuilder,LocalizedString> builder)	Localized description of the ShippingMethod.
ShippingMethodDraftBuilder	withLocalizedName(Function<LocalizedStringBuilder,LocalizedString> builder)	Localized name of the ShippingMethod.
ShippingMethodDraftBuilder	withTaxCategory(Function<TaxCategoryResourceIdentifierBuilder,TaxCategoryResourceIdentifier> builder)	TaxCategory for all ZoneRates of the ShippingMethod.
ShippingMethodDraftBuilder	withZoneRates(Function<ZoneRateDraftBuilder,ZoneRateDraftBuilder> builder)	Defines ShippingRates (prices) for specific zones.
ShippingMethodDraftBuilder	zoneRates(ZoneRateDraft... zoneRates)	Defines ShippingRates (prices) for specific zones.
ShippingMethodDraftBuilder	zoneRates(List<ZoneRateDraft> zoneRates)	Defines ShippingRates (prices) for specific zones.

Methods inherited from class java.lang.Object

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

Constructor Details

ShippingMethodDraftBuilder

public ShippingMethodDraftBuilder()

Method Details

key

public ShippingMethodDraftBuilder key(@Nullable
 String key)

User-defined unique identifier for the ShippingMethod.

Parameters:

key - value to be set

Returns:

Builder

name

public ShippingMethodDraftBuilder name(String name)

Unique name for the ShippingMethod within a Project.

Parameters:

name - value to be set

Returns:

Builder

localizedName

public ShippingMethodDraftBuilder localizedName(Function<LocalizedStringBuilder,LocalizedStringBuilder> builder)

Localized name of the ShippingMethod.

Parameters:

builder - function to build the localizedName value

Returns:

Builder

withLocalizedName

public ShippingMethodDraftBuilder withLocalizedName(Function<LocalizedStringBuilder,LocalizedString> builder)

Localized name of the ShippingMethod.

Parameters:

builder - function to build the localizedName value

Returns:

Builder

localizedName

public ShippingMethodDraftBuilder localizedName(@Nullable
 LocalizedString localizedName)

Localized name of the ShippingMethod.

Parameters:

localizedName - value to be set

Returns:

Builder

description

@Deprecated
public ShippingMethodDraftBuilder description(@Nullable
 String description)

Deprecated.

Description of the ShippingMethod.

Parameters:

description - value to be set

Returns:

Builder

localizedDescription

public ShippingMethodDraftBuilder localizedDescription(Function<LocalizedStringBuilder,LocalizedStringBuilder> builder)

Localized description of the ShippingMethod.

Parameters:

builder - function to build the localizedDescription value

Returns:

Builder

withLocalizedDescription

public ShippingMethodDraftBuilder withLocalizedDescription(Function<LocalizedStringBuilder,LocalizedString> builder)

Localized description of the ShippingMethod.

Parameters:

builder - function to build the localizedDescription value

Returns:

Builder

localizedDescription

public ShippingMethodDraftBuilder localizedDescription(@Nullable
 LocalizedString localizedDescription)

Localized description of the ShippingMethod.

Parameters:

localizedDescription - value to be set

Returns:

Builder

taxCategory

public ShippingMethodDraftBuilder taxCategory(Function<TaxCategoryResourceIdentifierBuilder,TaxCategoryResourceIdentifierBuilder> builder)

TaxCategory for all ZoneRates of the ShippingMethod.

Parameters:

builder - function to build the taxCategory value

Returns:

Builder

withTaxCategory

public ShippingMethodDraftBuilder withTaxCategory(Function<TaxCategoryResourceIdentifierBuilder,TaxCategoryResourceIdentifier> builder)

TaxCategory for all ZoneRates of the ShippingMethod.

Parameters:

builder - function to build the taxCategory value

Returns:

Builder

taxCategory

public ShippingMethodDraftBuilder taxCategory(TaxCategoryResourceIdentifier taxCategory)

TaxCategory for all ZoneRates of the ShippingMethod.

Parameters:

taxCategory - value to be set

Returns:

Builder

zoneRates

public ShippingMethodDraftBuilder zoneRates(ZoneRateDraft... zoneRates)

Defines ShippingRates (prices) for specific zones.

Parameters:

zoneRates - value to be set

Returns:

Builder

zoneRates

public ShippingMethodDraftBuilder zoneRates(List<ZoneRateDraft> zoneRates)

Defines ShippingRates (prices) for specific zones.

Parameters:

zoneRates - value to be set

Returns:

Builder

plusZoneRates

public ShippingMethodDraftBuilder plusZoneRates(ZoneRateDraft... zoneRates)

Defines ShippingRates (prices) for specific zones.

Parameters:

zoneRates - value to be set

Returns:

Builder

plusZoneRates

public ShippingMethodDraftBuilder plusZoneRates(Function<ZoneRateDraftBuilder,ZoneRateDraftBuilder> builder)

Defines ShippingRates (prices) for specific zones.

Parameters:

builder - function to build the zoneRates value

Returns:

Builder

withZoneRates

public ShippingMethodDraftBuilder withZoneRates(Function<ZoneRateDraftBuilder,ZoneRateDraftBuilder> builder)

Defines ShippingRates (prices) for specific zones.

Parameters:

builder - function to build the zoneRates value

Returns:

Builder

addZoneRates

public ShippingMethodDraftBuilder addZoneRates(Function<ZoneRateDraftBuilder,ZoneRateDraft> builder)

Defines ShippingRates (prices) for specific zones.

Parameters:

builder - function to build the zoneRates value

Returns:

Builder

setZoneRates

public ShippingMethodDraftBuilder setZoneRates(Function<ZoneRateDraftBuilder,ZoneRateDraft> builder)

Defines ShippingRates (prices) for specific zones.

Parameters:

builder - function to build the zoneRates value

Returns:

Builder

active

public ShippingMethodDraftBuilder active(@Nullable
 Boolean active)

If set to true, the ShippingMethod can be used during the creation or update of a Cart or Order.

Parameters:

active - value to be set

Returns:

Builder

isDefault

public ShippingMethodDraftBuilder isDefault(Boolean isDefault)

If set to true, the ShippingMethod will be the Project's default ShippingMethod.

Parameters:

isDefault - value to be set

Returns:

Builder

predicate

public ShippingMethodDraftBuilder predicate(@Nullable
 String predicate)

Valid Cart predicate to select a ShippingMethod for a Cart.

Parameters:

predicate - value to be set

Returns:

Builder

custom

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

Custom Fields for the ShippingMethod.

Parameters:

builder - function to build the custom value

Returns:

Builder

withCustom

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

Custom Fields for the ShippingMethod.

Parameters:

builder - function to build the custom value

Returns:

Builder

custom

public ShippingMethodDraftBuilder custom(@Nullable
 CustomFieldsDraft custom)

Custom Fields for the ShippingMethod.

Parameters:

custom - value to be set

Returns:

Builder

getKey

@Nullable
public String getKey()

User-defined unique identifier for the ShippingMethod.

Returns:

key

getName

public String getName()

Unique name for the ShippingMethod within a Project.

Returns:

name

getLocalizedName

@Nullable
public LocalizedString getLocalizedName()

Localized name of the ShippingMethod.

Returns:

localizedName

getDescription

@Deprecated
@Nullable
public String getDescription()

Deprecated.

Description of the ShippingMethod.

Returns:

description

getLocalizedDescription

@Nullable
public LocalizedString getLocalizedDescription()

Localized description of the ShippingMethod.

Returns:

localizedDescription

getTaxCategory

public TaxCategoryResourceIdentifier getTaxCategory()

TaxCategory for all ZoneRates of the ShippingMethod.

Returns:

taxCategory

getZoneRates

public List<ZoneRateDraft> getZoneRates()

Defines ShippingRates (prices) for specific zones.

Returns:

zoneRates

getActive

@Nullable
public Boolean getActive()

If set to true, the ShippingMethod can be used during the creation or update of a Cart or Order.

Returns:

active

getIsDefault

public Boolean getIsDefault()

If set to true, the ShippingMethod will be the Project's default ShippingMethod.

Returns:

isDefault

getPredicate

@Nullable
public String getPredicate()

Valid Cart predicate to select a ShippingMethod for a Cart.

Returns:

predicate

getCustom

@Nullable
public CustomFieldsDraft getCustom()

Custom Fields for the ShippingMethod.

Returns:

custom

build

public ShippingMethodDraft build()

builds ShippingMethodDraft with checking for non-null required values

Specified by:

build in interface Builder<ShippingMethodDraft>

Returns:

ShippingMethodDraft

buildUnchecked

public ShippingMethodDraft buildUnchecked()

builds ShippingMethodDraft without checking for non-null required values

Returns:

ShippingMethodDraft

of

public static ShippingMethodDraftBuilder of()

factory method for an instance of ShippingMethodDraftBuilder

Returns:

builder

of

public static ShippingMethodDraftBuilder of(ShippingMethodDraft template)

create builder for ShippingMethodDraft instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder