Package com.commercetools.api.models.order

Interface ParcelDraft

All Superinterfaces:

CustomizableDraft<ParcelDraft>, io.vrap.rmf.base.client.Draft<ParcelDraft>

All Known Implementing Classes:

ParcelDraftImpl

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

ParcelDraft Example to create an instance using the builder pattern

     ParcelDraft parcelDraft = ParcelDraft.builder()
             .build()
 

Method Summary

Modifier and Type	Method	Description
static ParcelDraftBuilder	builder()	builder factory method for ParcelDraft
static ParcelDraftBuilder	builder(ParcelDraft template)	create builder for ParcelDraft instance
static ParcelDraft	deepCopy(ParcelDraft template)	factory method to create a deep copy of ParcelDraft
@Valid CustomFieldsDraft	getCustom()	Custom Fields of this parcel.
@Valid List<DeliveryItem>	getItems()	The delivery items contained in this parcel.
String	getKey()	User-defined unique identifier of the Parcel.
@Valid ParcelMeasurements	getMeasurements()
@Valid TrackingData	getTrackingData()
static ParcelDraft	of()	factory method
static ParcelDraft	of(ParcelDraft template)	factory method to create a shallow copy ParcelDraft
void	setCustom(CustomFieldsDraft custom)	Custom Fields of this parcel.
void	setItems(DeliveryItem... items)	The delivery items contained in this parcel.
void	setItems(List<DeliveryItem> items)	The delivery items contained in this parcel.
void	setKey(String key)	User-defined unique identifier of the Parcel.
void	setMeasurements(ParcelMeasurements measurements)	set measurements
void	setTrackingData(TrackingData trackingData)	set trackingData
static com.fasterxml.jackson.core.type.TypeReference<ParcelDraft>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withParcelDraft(Function<ParcelDraft,T> helper)	accessor map function

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

unwrapCustomizableDraft

Method Details

getKey

String getKey()

User-defined unique identifier of the Parcel.

Returns:

key

getMeasurements

@Valid
@Valid ParcelMeasurements getMeasurements()

Returns:

measurements

getTrackingData

@Valid
@Valid TrackingData getTrackingData()

Returns:

trackingData

getItems

@Valid
@Valid List<DeliveryItem> getItems()

The delivery items contained in this parcel.

Returns:

items

getCustom

@Valid
@Valid CustomFieldsDraft getCustom()

Custom Fields of this parcel.

Specified by:

getCustom in interface CustomizableDraft<ParcelDraft>

Returns:

custom

setKey

void setKey(String key)

User-defined unique identifier of the Parcel.

Parameters:

key - value to be set

setMeasurements

void setMeasurements(ParcelMeasurements measurements)

set measurements

Parameters:

measurements - value to be set

setTrackingData

void setTrackingData(TrackingData trackingData)

set trackingData

Parameters:

trackingData - value to be set

setItems

void setItems(DeliveryItem... items)

The delivery items contained in this parcel.

Parameters:

items - values to be set

setItems

void setItems(List<DeliveryItem> items)

The delivery items contained in this parcel.

Parameters:

items - values to be set

setCustom

void setCustom(CustomFieldsDraft custom)

Custom Fields of this parcel.

Specified by:

setCustom in interface CustomizableDraft<ParcelDraft>

Parameters:

custom - value to be set

of

static ParcelDraft of()

factory method

Returns:

instance of ParcelDraft

of

static ParcelDraft of(ParcelDraft template)

factory method to create a shallow copy ParcelDraft

Parameters:

template - instance to be copied

Returns:

copy instance

deepCopy

@Nullable
static ParcelDraft deepCopy(@Nullable
 ParcelDraft template)

factory method to create a deep copy of ParcelDraft

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static ParcelDraftBuilder builder()

builder factory method for ParcelDraft

Returns:

builder

builder

static ParcelDraftBuilder builder(ParcelDraft template)

create builder for ParcelDraft instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withParcelDraft

default <T> T withParcelDraft(Function<ParcelDraft,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<ParcelDraft> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference