Package com.commercetools.api.models.business_unit

Interface CompanyDraft

All Superinterfaces:

BusinessUnitDraft, Draft<CompanyDraft>, WithKey

public interface CompanyDraft
extends BusinessUnitDraft, Draft<CompanyDraft>

Draft type to represent the top level of a business. Contains the fields and values of the generic BusinessUnitDraft that are used specifically for creating a Company.

Example to create an instance using the builder pattern

     CompanyDraft companyDraft = CompanyDraft.builder()
             .key("{key}")
             .name("{name}")
             .build()
 

Field Summary

Fields

Modifier and Type	Field	Description
static final String	COMPANY	discriminator value for CompanyDraft

Method Summary

Modifier and Type	Method	Description
static CompanyDraftBuilder	builder()	builder factory method for CompanyDraft
static CompanyDraftBuilder	builder(CompanyDraft template)	create builder for CompanyDraft instance
CompanyDraft	copyDeep()
static CompanyDraft	deepCopy(CompanyDraft template)	factory method to create a deep copy of CompanyDraft
static CompanyDraft	of()	factory method
static CompanyDraft	of(CompanyDraft template)	factory method to create a shallow copy CompanyDraft
static com.fasterxml.jackson.core.type.TypeReference<CompanyDraft>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withCompanyDraft(Function<CompanyDraft,T> helper)	accessor map function

Methods inherited from interface com.commercetools.api.models.business_unit.BusinessUnitDraft

getAddresses, getApprovalRuleMode, getAssociateMode, getAssociates, getBillingAddresses, getContactEmail, getCustom, getDefaultBillingAddress, getDefaultShippingAddress, getKey, getName, getShippingAddresses, getStatus, getStoreMode, getStores, getUnitType, setAddresses, setAddresses, setApprovalRuleMode, setAssociateMode, setAssociates, setAssociates, setBillingAddresses, setBillingAddresses, setContactEmail, setCustom, setDefaultBillingAddress, setDefaultShippingAddress, setKey, setName, setShippingAddresses, setShippingAddresses, setStatus, setStoreMode, setStores, setStores, withBusinessUnitDraft

Field Details

COMPANY

static final String COMPANY

discriminator value for CompanyDraft

See Also:

• Constant Field Values

Method Details

of

static CompanyDraft of()

factory method

Returns:

instance of CompanyDraft

of

static CompanyDraft of(CompanyDraft template)

factory method to create a shallow copy CompanyDraft

Parameters:

template - instance to be copied

Returns:

copy instance

copyDeep

CompanyDraft copyDeep()

Specified by:

copyDeep in interface BusinessUnitDraft

deepCopy

@Nullable
static CompanyDraft deepCopy(@Nullable
 CompanyDraft template)

factory method to create a deep copy of CompanyDraft

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static CompanyDraftBuilder builder()

builder factory method for CompanyDraft

Returns:

builder

builder

static CompanyDraftBuilder builder(CompanyDraft template)

create builder for CompanyDraft instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withCompanyDraft

default <T> T withCompanyDraft(Function<CompanyDraft,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<CompanyDraft> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference