Package com.commercetools.api.models.business_unit

Class CompanyDraftBuilder

java.lang.Object

com.commercetools.api.models.business_unit.CompanyDraftBuilder

All Implemented Interfaces:

Builder<CompanyDraft>

public class CompanyDraftBuilder
extends Object
implements Builder<CompanyDraft>

CompanyDraftBuilder Example to create an instance using the builder pattern

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

Constructor Summary

Constructors

Constructor	Description
CompanyDraftBuilder()

Method Summary

Modifier and Type	Method	Description
CompanyDraftBuilder	addAddresses(Function<BaseAddressBuilder,BaseAddress> builder)	Addresses used by the Business Unit.
CompanyDraftBuilder	addAssociates(Function<AssociateDraftBuilder,AssociateDraft> builder)	List of members that are part of the Business Unit in specific roles.
CompanyDraftBuilder	addresses(BaseAddress... addresses)	Addresses used by the Business Unit.
CompanyDraftBuilder	addresses(List<BaseAddress> addresses)	Addresses used by the Business Unit.
CompanyDraftBuilder	addStores(Function<StoreResourceIdentifierBuilder,StoreResourceIdentifier> builder)	Sets the Stores the Business Unit is associated with.
CompanyDraftBuilder	approvalRuleMode(BusinessUnitApprovalRuleMode approvalRuleMode)	Determines whether the Business Unit can inherit Approval Rules from a parent.
CompanyDraftBuilder	associateMode(BusinessUnitAssociateMode associateMode)	Determines whether the Business Unit can inherit Associates from a parent.
CompanyDraftBuilder	associates(AssociateDraft... associates)	List of members that are part of the Business Unit in specific roles.
CompanyDraftBuilder	associates(List<AssociateDraft> associates)	List of members that are part of the Business Unit in specific roles.
CompanyDraftBuilder	billingAddresses(Integer... billingAddresses)	Indexes of entries in addresses to set as billing addresses.
CompanyDraftBuilder	billingAddresses(List<Integer> billingAddresses)	Indexes of entries in addresses to set as billing addresses.
CompanyDraft	build()	builds CompanyDraft with checking for non-null required values
CompanyDraft	buildUnchecked()	builds CompanyDraft without checking for non-null required values
CompanyDraftBuilder	contactEmail(String contactEmail)	Email address of the Business Unit.
CompanyDraftBuilder	custom(CustomFieldsDraft custom)	Custom Fields for the Business Unit.
CompanyDraftBuilder	custom(Function<CustomFieldsDraftBuilder,CustomFieldsDraftBuilder> builder)	Custom Fields for the Business Unit.
CompanyDraftBuilder	defaultBillingAddress(Integer defaultBillingAddress)	Index of the entry in addresses to set as the default billing address.
CompanyDraftBuilder	defaultShippingAddress(Integer defaultShippingAddress)	Index of the entry in addresses to set as the default shipping address.
List<BaseAddress>	getAddresses()	Addresses used by the Business Unit.
BusinessUnitApprovalRuleMode	getApprovalRuleMode()	Determines whether the Business Unit can inherit Approval Rules from a parent.
BusinessUnitAssociateMode	getAssociateMode()	Determines whether the Business Unit can inherit Associates from a parent.
List<AssociateDraft>	getAssociates()	List of members that are part of the Business Unit in specific roles.
List<Integer>	getBillingAddresses()	Indexes of entries in addresses to set as billing addresses.
String	getContactEmail()	Email address of the Business Unit.
CustomFieldsDraft	getCustom()	Custom Fields for the Business Unit.
Integer	getDefaultBillingAddress()	Index of the entry in addresses to set as the default billing address.
Integer	getDefaultShippingAddress()	Index of the entry in addresses to set as the default shipping address.
String	getKey()	User-defined unique and immutable identifier for the Business Unit.
String	getName()	Name of the Business Unit.
List<Integer>	getShippingAddresses()	Indexes of entries in addresses to set as shipping addresses.
BusinessUnitStatus	getStatus()	Indicates whether the Business Unit can be edited and used in Orders.
BusinessUnitStoreMode	getStoreMode()	Defines whether the Stores of the Business Unit are set directly on the Business Unit or are inherited from a parent.
List<StoreResourceIdentifier>	getStores()	Sets the Stores the Business Unit is associated with.
CompanyDraftBuilder	key(String key)	User-defined unique and immutable identifier for the Business Unit.
CompanyDraftBuilder	name(String name)	Name of the Business Unit.
static CompanyDraftBuilder	of()	factory method for an instance of CompanyDraftBuilder
static CompanyDraftBuilder	of(CompanyDraft template)	create builder for CompanyDraft instance
CompanyDraftBuilder	plusAddresses(BaseAddress... addresses)	Addresses used by the Business Unit.
CompanyDraftBuilder	plusAddresses(Function<BaseAddressBuilder,BaseAddressBuilder> builder)	Addresses used by the Business Unit.
CompanyDraftBuilder	plusAssociates(AssociateDraft... associates)	List of members that are part of the Business Unit in specific roles.
CompanyDraftBuilder	plusAssociates(Function<AssociateDraftBuilder,AssociateDraftBuilder> builder)	List of members that are part of the Business Unit in specific roles.
CompanyDraftBuilder	plusBillingAddresses(Integer... billingAddresses)	Indexes of entries in addresses to set as billing addresses.
CompanyDraftBuilder	plusShippingAddresses(Integer... shippingAddresses)	Indexes of entries in addresses to set as shipping addresses.
CompanyDraftBuilder	plusStores(StoreResourceIdentifier... stores)	Sets the Stores the Business Unit is associated with.
CompanyDraftBuilder	plusStores(Function<StoreResourceIdentifierBuilder,StoreResourceIdentifierBuilder> builder)	Sets the Stores the Business Unit is associated with.
CompanyDraftBuilder	setAddresses(Function<BaseAddressBuilder,BaseAddress> builder)	Addresses used by the Business Unit.
CompanyDraftBuilder	setAssociates(Function<AssociateDraftBuilder,AssociateDraft> builder)	List of members that are part of the Business Unit in specific roles.
CompanyDraftBuilder	setStores(Function<StoreResourceIdentifierBuilder,StoreResourceIdentifier> builder)	Sets the Stores the Business Unit is associated with.
CompanyDraftBuilder	shippingAddresses(Integer... shippingAddresses)	Indexes of entries in addresses to set as shipping addresses.
CompanyDraftBuilder	shippingAddresses(List<Integer> shippingAddresses)	Indexes of entries in addresses to set as shipping addresses.
CompanyDraftBuilder	status(BusinessUnitStatus status)	Indicates whether the Business Unit can be edited and used in Orders.
CompanyDraftBuilder	storeMode(BusinessUnitStoreMode storeMode)	Defines whether the Stores of the Business Unit are set directly on the Business Unit or are inherited from a parent.
CompanyDraftBuilder	stores(StoreResourceIdentifier... stores)	Sets the Stores the Business Unit is associated with.
CompanyDraftBuilder	stores(List<StoreResourceIdentifier> stores)	Sets the Stores the Business Unit is associated with.
CompanyDraftBuilder	withAddresses(Function<BaseAddressBuilder,BaseAddressBuilder> builder)	Addresses used by the Business Unit.
CompanyDraftBuilder	withAssociates(Function<AssociateDraftBuilder,AssociateDraftBuilder> builder)	List of members that are part of the Business Unit in specific roles.
CompanyDraftBuilder	withCustom(Function<CustomFieldsDraftBuilder,CustomFieldsDraft> builder)	Custom Fields for the Business Unit.
CompanyDraftBuilder	withStores(Function<StoreResourceIdentifierBuilder,StoreResourceIdentifierBuilder> builder)	Sets the Stores the Business Unit is associated with.

Methods inherited from class java.lang.Object

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

Constructor Details

CompanyDraftBuilder

public CompanyDraftBuilder()

Method Details

key

public CompanyDraftBuilder key(String key)

User-defined unique and immutable identifier for the Business Unit.

Parameters:

key - value to be set

Returns:

Builder

status

public CompanyDraftBuilder status(@Nullable
 BusinessUnitStatus status)

Indicates whether the Business Unit can be edited and used in Orders.

Parameters:

status - value to be set

Returns:

Builder

stores

public CompanyDraftBuilder stores(@Nullable
 StoreResourceIdentifier... stores)

Sets the Stores the Business Unit is associated with. Can only be set when storeMode is Explicit. Defaults to empty for Companies and not set for Divisions.

If the Business Unit has Stores defined, then all of its Carts, Orders, Recurring Orders, Quotes, Quote Requests, or Shopping Lists must belong to one of the Business Unit's Stores.

If the Business Unit has no Stores, then all of its Carts, Orders, Recurring Orders, Quotes, Quote Requests, or Shopping Lists must not belong to any Store.

Parameters:

stores - value to be set

Returns:

Builder

stores

public CompanyDraftBuilder stores(@Nullable
 List<StoreResourceIdentifier> stores)

Sets the Stores the Business Unit is associated with. Can only be set when storeMode is Explicit. Defaults to empty for Companies and not set for Divisions.

If the Business Unit has Stores defined, then all of its Carts, Orders, Recurring Orders, Quotes, Quote Requests, or Shopping Lists must belong to one of the Business Unit's Stores.

If the Business Unit has no Stores, then all of its Carts, Orders, Recurring Orders, Quotes, Quote Requests, or Shopping Lists must not belong to any Store.

Parameters:

stores - value to be set

Returns:

Builder

plusStores

public CompanyDraftBuilder plusStores(@Nullable
 StoreResourceIdentifier... stores)

Sets the Stores the Business Unit is associated with. Can only be set when storeMode is Explicit. Defaults to empty for Companies and not set for Divisions.

If the Business Unit has Stores defined, then all of its Carts, Orders, Recurring Orders, Quotes, Quote Requests, or Shopping Lists must belong to one of the Business Unit's Stores.

If the Business Unit has no Stores, then all of its Carts, Orders, Recurring Orders, Quotes, Quote Requests, or Shopping Lists must not belong to any Store.

Parameters:

stores - value to be set

Returns:

Builder

plusStores

public CompanyDraftBuilder plusStores(Function<StoreResourceIdentifierBuilder,StoreResourceIdentifierBuilder> builder)

Sets the Stores the Business Unit is associated with. Can only be set when storeMode is Explicit. Defaults to empty for Companies and not set for Divisions.

If the Business Unit has Stores defined, then all of its Carts, Orders, Recurring Orders, Quotes, Quote Requests, or Shopping Lists must belong to one of the Business Unit's Stores.

If the Business Unit has no Stores, then all of its Carts, Orders, Recurring Orders, Quotes, Quote Requests, or Shopping Lists must not belong to any Store.

Parameters:

builder - function to build the stores value

Returns:

Builder

withStores

public CompanyDraftBuilder withStores(Function<StoreResourceIdentifierBuilder,StoreResourceIdentifierBuilder> builder)

Sets the Stores the Business Unit is associated with. Can only be set when storeMode is Explicit. Defaults to empty for Companies and not set for Divisions.

If the Business Unit has Stores defined, then all of its Carts, Orders, Recurring Orders, Quotes, Quote Requests, or Shopping Lists must belong to one of the Business Unit's Stores.

If the Business Unit has no Stores, then all of its Carts, Orders, Recurring Orders, Quotes, Quote Requests, or Shopping Lists must not belong to any Store.

Parameters:

builder - function to build the stores value

Returns:

Builder

addStores

public CompanyDraftBuilder addStores(Function<StoreResourceIdentifierBuilder,StoreResourceIdentifier> builder)

Sets the Stores the Business Unit is associated with. Can only be set when storeMode is Explicit. Defaults to empty for Companies and not set for Divisions.

If the Business Unit has Stores defined, then all of its Carts, Orders, Recurring Orders, Quotes, Quote Requests, or Shopping Lists must belong to one of the Business Unit's Stores.

If the Business Unit has no Stores, then all of its Carts, Orders, Recurring Orders, Quotes, Quote Requests, or Shopping Lists must not belong to any Store.

Parameters:

builder - function to build the stores value

Returns:

Builder

setStores

public CompanyDraftBuilder setStores(Function<StoreResourceIdentifierBuilder,StoreResourceIdentifier> builder)

Sets the Stores the Business Unit is associated with. Can only be set when storeMode is Explicit. Defaults to empty for Companies and not set for Divisions.

If the Business Unit has Stores defined, then all of its Carts, Orders, Recurring Orders, Quotes, Quote Requests, or Shopping Lists must belong to one of the Business Unit's Stores.

If the Business Unit has no Stores, then all of its Carts, Orders, Recurring Orders, Quotes, Quote Requests, or Shopping Lists must not belong to any Store.

Parameters:

builder - function to build the stores value

Returns:

Builder

storeMode

public CompanyDraftBuilder storeMode(@Nullable
 BusinessUnitStoreMode storeMode)

Defines whether the Stores of the Business Unit are set directly on the Business Unit or are inherited from a parent. storeMode is always Explicit for Companies and defaults to FromParent for Divisions.

Parameters:

storeMode - value to be set

Returns:

Builder

name

public CompanyDraftBuilder name(String name)

Name of the Business Unit.

Parameters:

name - value to be set

Returns:

Builder

contactEmail

public CompanyDraftBuilder contactEmail(@Nullable
 String contactEmail)

Email address of the Business Unit.

Parameters:

contactEmail - value to be set

Returns:

Builder

associateMode

public CompanyDraftBuilder associateMode(@Nullable
 BusinessUnitAssociateMode associateMode)

Determines whether the Business Unit can inherit Associates from a parent. Always Explicit for Companies and defaults to ExplicitAndFromParent for Divisions.

Parameters:

associateMode - value to be set

Returns:

Builder

associates

public CompanyDraftBuilder associates(@Nullable
 AssociateDraft... associates)

List of members that are part of the Business Unit in specific roles.

Parameters:

associates - value to be set

Returns:

Builder

associates

public CompanyDraftBuilder associates(@Nullable
 List<AssociateDraft> associates)

List of members that are part of the Business Unit in specific roles.

Parameters:

associates - value to be set

Returns:

Builder

plusAssociates

public CompanyDraftBuilder plusAssociates(@Nullable
 AssociateDraft... associates)

List of members that are part of the Business Unit in specific roles.

Parameters:

associates - value to be set

Returns:

Builder

plusAssociates

public CompanyDraftBuilder plusAssociates(Function<AssociateDraftBuilder,AssociateDraftBuilder> builder)

List of members that are part of the Business Unit in specific roles.

Parameters:

builder - function to build the associates value

Returns:

Builder

withAssociates

public CompanyDraftBuilder withAssociates(Function<AssociateDraftBuilder,AssociateDraftBuilder> builder)

List of members that are part of the Business Unit in specific roles.

Parameters:

builder - function to build the associates value

Returns:

Builder

addAssociates

public CompanyDraftBuilder addAssociates(Function<AssociateDraftBuilder,AssociateDraft> builder)

List of members that are part of the Business Unit in specific roles.

Parameters:

builder - function to build the associates value

Returns:

Builder

setAssociates

public CompanyDraftBuilder setAssociates(Function<AssociateDraftBuilder,AssociateDraft> builder)

List of members that are part of the Business Unit in specific roles.

Parameters:

builder - function to build the associates value

Returns:

Builder

approvalRuleMode

public CompanyDraftBuilder approvalRuleMode(@Nullable
 BusinessUnitApprovalRuleMode approvalRuleMode)

Determines whether the Business Unit can inherit Approval Rules from a parent. For Companies, the value of this field is always Explicit. For Divisions, the default value is ExplicitAndFromParent.

Parameters:

approvalRuleMode - value to be set

Returns:

Builder

addresses

public CompanyDraftBuilder addresses(@Nullable
 BaseAddress... addresses)

Addresses used by the Business Unit.

Parameters:

addresses - value to be set

Returns:

Builder

addresses

public CompanyDraftBuilder addresses(@Nullable
 List<BaseAddress> addresses)

Addresses used by the Business Unit.

Parameters:

addresses - value to be set

Returns:

Builder

plusAddresses

public CompanyDraftBuilder plusAddresses(@Nullable
 BaseAddress... addresses)

Addresses used by the Business Unit.

Parameters:

addresses - value to be set

Returns:

Builder

plusAddresses

public CompanyDraftBuilder plusAddresses(Function<BaseAddressBuilder,BaseAddressBuilder> builder)

Addresses used by the Business Unit.

Parameters:

builder - function to build the addresses value

Returns:

Builder

withAddresses

public CompanyDraftBuilder withAddresses(Function<BaseAddressBuilder,BaseAddressBuilder> builder)

Addresses used by the Business Unit.

Parameters:

builder - function to build the addresses value

Returns:

Builder

addAddresses

public CompanyDraftBuilder addAddresses(Function<BaseAddressBuilder,BaseAddress> builder)

Addresses used by the Business Unit.

Parameters:

builder - function to build the addresses value

Returns:

Builder

setAddresses

public CompanyDraftBuilder setAddresses(Function<BaseAddressBuilder,BaseAddress> builder)

Addresses used by the Business Unit.

Parameters:

builder - function to build the addresses value

Returns:

Builder

shippingAddresses

public CompanyDraftBuilder shippingAddresses(@Nullable
 Integer... shippingAddresses)

Indexes of entries in addresses to set as shipping addresses. The shippingAddressIds of the Customer will be replaced by these addresses.

Parameters:

shippingAddresses - value to be set

Returns:

Builder

shippingAddresses

public CompanyDraftBuilder shippingAddresses(@Nullable
 List<Integer> shippingAddresses)

Indexes of entries in addresses to set as shipping addresses. The shippingAddressIds of the Customer will be replaced by these addresses.

Parameters:

shippingAddresses - value to be set

Returns:

Builder

plusShippingAddresses

public CompanyDraftBuilder plusShippingAddresses(@Nullable
 Integer... shippingAddresses)

Indexes of entries in addresses to set as shipping addresses. The shippingAddressIds of the Customer will be replaced by these addresses.

Parameters:

shippingAddresses - value to be set

Returns:

Builder

defaultShippingAddress

public CompanyDraftBuilder defaultShippingAddress(@Nullable
 Integer defaultShippingAddress)

Index of the entry in addresses to set as the default shipping address.

Parameters:

defaultShippingAddress - value to be set

Returns:

Builder

billingAddresses

public CompanyDraftBuilder billingAddresses(@Nullable
 Integer... billingAddresses)

Indexes of entries in addresses to set as billing addresses. The billingAddressIds of the Customer will be replaced by these addresses.

Parameters:

billingAddresses - value to be set

Returns:

Builder

billingAddresses

public CompanyDraftBuilder billingAddresses(@Nullable
 List<Integer> billingAddresses)

Indexes of entries in addresses to set as billing addresses. The billingAddressIds of the Customer will be replaced by these addresses.

Parameters:

billingAddresses - value to be set

Returns:

Builder

plusBillingAddresses

public CompanyDraftBuilder plusBillingAddresses(@Nullable
 Integer... billingAddresses)

Indexes of entries in addresses to set as billing addresses. The billingAddressIds of the Customer will be replaced by these addresses.

Parameters:

billingAddresses - value to be set

Returns:

Builder

defaultBillingAddress

public CompanyDraftBuilder defaultBillingAddress(@Nullable
 Integer defaultBillingAddress)

Index of the entry in addresses to set as the default billing address.

Parameters:

defaultBillingAddress - value to be set

Returns:

Builder

custom

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

Custom Fields for the Business Unit.

Parameters:

builder - function to build the custom value

Returns:

Builder

withCustom

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

Custom Fields for the Business Unit.

Parameters:

builder - function to build the custom value

Returns:

Builder

custom

public CompanyDraftBuilder custom(@Nullable
 CustomFieldsDraft custom)

Custom Fields for the Business Unit.

Parameters:

custom - value to be set

Returns:

Builder

getKey

public String getKey()

User-defined unique and immutable identifier for the Business Unit.

Returns:

key

getStatus

@Nullable
public BusinessUnitStatus getStatus()

Indicates whether the Business Unit can be edited and used in Orders.

Returns:

status

getStores

@Nullable
public List<StoreResourceIdentifier> getStores()

Sets the Stores the Business Unit is associated with. Can only be set when storeMode is Explicit. Defaults to empty for Companies and not set for Divisions.

If the Business Unit has Stores defined, then all of its Carts, Orders, Recurring Orders, Quotes, Quote Requests, or Shopping Lists must belong to one of the Business Unit's Stores.

If the Business Unit has no Stores, then all of its Carts, Orders, Recurring Orders, Quotes, Quote Requests, or Shopping Lists must not belong to any Store.

Returns:

stores

getStoreMode

@Nullable
public BusinessUnitStoreMode getStoreMode()

Defines whether the Stores of the Business Unit are set directly on the Business Unit or are inherited from a parent. storeMode is always Explicit for Companies and defaults to FromParent for Divisions.

Returns:

storeMode

getName

public String getName()

Name of the Business Unit.

Returns:

name

getContactEmail

@Nullable
public String getContactEmail()

Email address of the Business Unit.

Returns:

contactEmail

getAssociateMode

@Nullable
public BusinessUnitAssociateMode getAssociateMode()

Determines whether the Business Unit can inherit Associates from a parent. Always Explicit for Companies and defaults to ExplicitAndFromParent for Divisions.

Returns:

associateMode

getAssociates

@Nullable
public List<AssociateDraft> getAssociates()

List of members that are part of the Business Unit in specific roles.

Returns:

associates

getApprovalRuleMode

@Nullable
public BusinessUnitApprovalRuleMode getApprovalRuleMode()

Determines whether the Business Unit can inherit Approval Rules from a parent. For Companies, the value of this field is always Explicit. For Divisions, the default value is ExplicitAndFromParent.

Returns:

approvalRuleMode

getAddresses

@Nullable
public List<BaseAddress> getAddresses()

Addresses used by the Business Unit.

Returns:

addresses

getShippingAddresses

@Nullable
public List<Integer> getShippingAddresses()

Indexes of entries in addresses to set as shipping addresses. The shippingAddressIds of the Customer will be replaced by these addresses.

Returns:

shippingAddresses

getDefaultShippingAddress

@Nullable
public Integer getDefaultShippingAddress()

Index of the entry in addresses to set as the default shipping address.

Returns:

defaultShippingAddress

getBillingAddresses

@Nullable
public List<Integer> getBillingAddresses()

Indexes of entries in addresses to set as billing addresses. The billingAddressIds of the Customer will be replaced by these addresses.

Returns:

billingAddresses

getDefaultBillingAddress

@Nullable
public Integer getDefaultBillingAddress()

Index of the entry in addresses to set as the default billing address.

Returns:

defaultBillingAddress

getCustom

@Nullable
public CustomFieldsDraft getCustom()

Custom Fields for the Business Unit.

Returns:

custom

build

public CompanyDraft build()

builds CompanyDraft with checking for non-null required values

Specified by:

build in interface Builder<CompanyDraft>

Returns:

CompanyDraft

buildUnchecked

public CompanyDraft buildUnchecked()

builds CompanyDraft without checking for non-null required values

Returns:

CompanyDraft

of

public static CompanyDraftBuilder of()

factory method for an instance of CompanyDraftBuilder

Returns:

builder

of

public static CompanyDraftBuilder of(CompanyDraft template)

create builder for CompanyDraft instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder