Package com.commercetools.api.models.business_unit

Class BusinessUnitDraftImpl

java.lang.Object

com.commercetools.api.models.business_unit.BusinessUnitDraftImpl

All Implemented Interfaces:

BusinessUnitDraft, WithKey, io.vrap.rmf.base.client.ModelBase

public class BusinessUnitDraftImpl
extends Object
implements BusinessUnitDraft, io.vrap.rmf.base.client.ModelBase

Generic draft type to model those fields all Business Units have in common. The additional fields required for creating a Company or Division are represented on CompanyDraft and DivisionDraft.

Nested Class Summary

Nested classes/interfaces inherited from interface io.vrap.rmf.base.client.ModelBase

io.vrap.rmf.base.client.ModelBase.FilteredRecursiveToStringStyle

Constructor Summary

Constructors

Constructor	Description
BusinessUnitDraftImpl()	create empty instance

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
List<BaseAddress>	getAddresses()	Addresses used by the Business Unit.
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 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.
BusinessUnitType	getUnitType()	Type of the Business Unit indicating its position in a hierarchy.
int	hashCode()
void	setAddresses(BaseAddress... addresses)	Addresses used by the Business Unit.
void	setAddresses(List<BaseAddress> addresses)	Addresses used by the Business Unit.
void	setAssociateMode(BusinessUnitAssociateMode associateMode)	Determines whether the Business Unit can inherit Associates from a parent.
void	setAssociates(AssociateDraft... associates)	List of members that are part of the Business Unit in specific roles.
void	setAssociates(List<AssociateDraft> associates)	List of members that are part of the Business Unit in specific roles.
void	setBillingAddresses(Integer... billingAddresses)	Indexes of entries in addresses to set as billing addresses.
void	setBillingAddresses(List<Integer> billingAddresses)	Indexes of entries in addresses to set as billing addresses.
void	setContactEmail(String contactEmail)	Email address of the Business Unit.
void	setCustom(CustomFieldsDraft custom)	Custom Fields for the Business Unit.
void	setDefaultBillingAddress(Integer defaultBillingAddress)	Index of the entry in addresses to set as the default billing address.
void	setDefaultShippingAddress(Integer defaultShippingAddress)	Index of the entry in addresses to set as the default shipping address.
void	setKey(String key)	User-defined unique identifier for the Business Unit.
void	setName(String name)	Name of the Business Unit.
void	setShippingAddresses(Integer... shippingAddresses)	Indexes of entries in addresses to set as shipping addresses.
void	setShippingAddresses(List<Integer> shippingAddresses)	Indexes of entries in addresses to set as shipping addresses.
void	setStatus(BusinessUnitStatus status)	Indicates whether the Business Unit can be edited and used in Orders.
void	setStoreMode(BusinessUnitStoreMode storeMode)	Defines whether the Stores of the Business Unit are set directly on the Business Unit or are inherited from a parent.
void	setStores(StoreResourceIdentifier... stores)	Sets the Stores the Business Unit is associated with.
void	setStores(List<StoreResourceIdentifier> stores)	Sets the Stores the Business Unit is associated with.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, toString, wait, wait, wait

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

withBusinessUnitDraft

Methods inherited from interface io.vrap.rmf.base.client.ModelBase

reflectionString, reflectionString

Constructor Details

BusinessUnitDraftImpl

public BusinessUnitDraftImpl()

create empty instance

Method Details

getKey

public String getKey()

User-defined unique identifier for the Business Unit.

Specified by:

getKey in interface BusinessUnitDraft

Specified by:

getKey in interface WithKey

Returns:

key

getStatus

public BusinessUnitStatus getStatus()

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

Specified by:

getStatus in interface BusinessUnitDraft

Returns:

status

getStores

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, Quotes, or Quote Requests must belong to one of the Business Unit's Stores.

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

Specified by:

getStores in interface BusinessUnitDraft

Returns:

stores

getStoreMode

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.

Specified by:

getStoreMode in interface BusinessUnitDraft

Returns:

storeMode

getUnitType

public BusinessUnitType getUnitType()

Type of the Business Unit indicating its position in a hierarchy.

Specified by:

getUnitType in interface BusinessUnitDraft

Returns:

unitType

getName

public String getName()

Name of the Business Unit.

Specified by:

getName in interface BusinessUnitDraft

Returns:

name

getContactEmail

public String getContactEmail()

Email address of the Business Unit.

Specified by:

getContactEmail in interface BusinessUnitDraft

Returns:

contactEmail

getAssociateMode

public BusinessUnitAssociateMode getAssociateMode()

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

Specified by:

getAssociateMode in interface BusinessUnitDraft

Returns:

associateMode

getAssociates

public List<AssociateDraft> getAssociates()

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

Specified by:

getAssociates in interface BusinessUnitDraft

Returns:

associates

getAddresses

public List<BaseAddress> getAddresses()

Addresses used by the Business Unit.

Specified by:

getAddresses in interface BusinessUnitDraft

Returns:

addresses

getShippingAddresses

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.

Specified by:

getShippingAddresses in interface BusinessUnitDraft

Returns:

shippingAddresses

getDefaultShippingAddress

public Integer getDefaultShippingAddress()

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

Specified by:

getDefaultShippingAddress in interface BusinessUnitDraft

Returns:

defaultShippingAddress

getBillingAddresses

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.

Specified by:

getBillingAddresses in interface BusinessUnitDraft

Returns:

billingAddresses

getDefaultBillingAddress

public Integer getDefaultBillingAddress()

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

Specified by:

getDefaultBillingAddress in interface BusinessUnitDraft

Returns:

defaultBillingAddress

getCustom

public CustomFieldsDraft getCustom()

Custom Fields for the Business Unit.

Specified by:

getCustom in interface BusinessUnitDraft

Returns:

custom

setKey

public void setKey(String key)

Description copied from interface: BusinessUnitDraft

User-defined unique identifier for the Business Unit.

Specified by:

setKey in interface BusinessUnitDraft

Parameters:

key - value to be set

setStatus

public void setStatus(BusinessUnitStatus status)

Description copied from interface: BusinessUnitDraft

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

Specified by:

setStatus in interface BusinessUnitDraft

Parameters:

status - value to be set

setStores

public void setStores(StoreResourceIdentifier... stores)

Description copied from interface: BusinessUnitDraft

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, Quotes, or Quote Requests must belong to one of the Business Unit's Stores.

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

Specified by:

setStores in interface BusinessUnitDraft

Parameters:

stores - values to be set

setStores

public void setStores(List<StoreResourceIdentifier> stores)

Description copied from interface: BusinessUnitDraft

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, Quotes, or Quote Requests must belong to one of the Business Unit's Stores.

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

Specified by:

setStores in interface BusinessUnitDraft

Parameters:

stores - values to be set

setStoreMode

public void setStoreMode(BusinessUnitStoreMode storeMode)

Description copied from interface: BusinessUnitDraft

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.

Specified by:

setStoreMode in interface BusinessUnitDraft

Parameters:

storeMode - value to be set

setName

public void setName(String name)

Description copied from interface: BusinessUnitDraft

Name of the Business Unit.

Specified by:

setName in interface BusinessUnitDraft

Parameters:

name - value to be set

setContactEmail

public void setContactEmail(String contactEmail)

Description copied from interface: BusinessUnitDraft

Email address of the Business Unit.

Specified by:

setContactEmail in interface BusinessUnitDraft

Parameters:

contactEmail - value to be set

setAssociateMode

public void setAssociateMode(BusinessUnitAssociateMode associateMode)

Description copied from interface: BusinessUnitDraft

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

Specified by:

setAssociateMode in interface BusinessUnitDraft

Parameters:

associateMode - value to be set

setAssociates

public void setAssociates(AssociateDraft... associates)

Description copied from interface: BusinessUnitDraft

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

Specified by:

setAssociates in interface BusinessUnitDraft

Parameters:

associates - values to be set

setAssociates

public void setAssociates(List<AssociateDraft> associates)

Description copied from interface: BusinessUnitDraft

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

Specified by:

setAssociates in interface BusinessUnitDraft

Parameters:

associates - values to be set

setAddresses

public void setAddresses(BaseAddress... addresses)

Description copied from interface: BusinessUnitDraft

Addresses used by the Business Unit.

Specified by:

setAddresses in interface BusinessUnitDraft

Parameters:

addresses - values to be set

setAddresses

public void setAddresses(List<BaseAddress> addresses)

Description copied from interface: BusinessUnitDraft

Addresses used by the Business Unit.

Specified by:

setAddresses in interface BusinessUnitDraft

Parameters:

addresses - values to be set

setShippingAddresses

public void setShippingAddresses(Integer... shippingAddresses)

Description copied from interface: BusinessUnitDraft

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

Specified by:

setShippingAddresses in interface BusinessUnitDraft

Parameters:

shippingAddresses - values to be set

setShippingAddresses

public void setShippingAddresses(List<Integer> shippingAddresses)

Description copied from interface: BusinessUnitDraft

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

Specified by:

setShippingAddresses in interface BusinessUnitDraft

Parameters:

shippingAddresses - values to be set

setDefaultShippingAddress

public void setDefaultShippingAddress(Integer defaultShippingAddress)

Description copied from interface: BusinessUnitDraft

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

Specified by:

setDefaultShippingAddress in interface BusinessUnitDraft

Parameters:

defaultShippingAddress - value to be set

setBillingAddresses

public void setBillingAddresses(Integer... billingAddresses)

Description copied from interface: BusinessUnitDraft

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

Specified by:

setBillingAddresses in interface BusinessUnitDraft

Parameters:

billingAddresses - values to be set

setBillingAddresses

public void setBillingAddresses(List<Integer> billingAddresses)

Description copied from interface: BusinessUnitDraft

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

Specified by:

setBillingAddresses in interface BusinessUnitDraft

Parameters:

billingAddresses - values to be set

setDefaultBillingAddress

public void setDefaultBillingAddress(Integer defaultBillingAddress)

Description copied from interface: BusinessUnitDraft

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

Specified by:

setDefaultBillingAddress in interface BusinessUnitDraft

Parameters:

defaultBillingAddress - value to be set

setCustom

public void setCustom(CustomFieldsDraft custom)

Description copied from interface: BusinessUnitDraft

Custom Fields for the Business Unit.

Specified by:

setCustom in interface BusinessUnitDraft

Parameters:

custom - value to be set

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object