Package com.broadleafcommerce.vendor.domain.request

Class VendorCreationRequest

java.lang.Object

com.broadleafcommerce.vendor.domain.request.VendorCreationRequest

All Implemented Interfaces:

Serializable

public class VendorCreationRequest
extends Object
implements Serializable

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
VendorCreationRequest()

Method Summary

Modifier and Type	Method	Description
protected boolean	canEqual(Object other)
boolean	equals(Object o)
Address	getAddress()	The primary address associated with this vendor.
AdminUserInfo	getAdminUser()	User information for an admin user that is to be created to manage this vendor.
String	getDefaultCurrency()	By default, TenantServices will create a vendor catalog upon notice of a new vendor being created.
String	getDefaultLocale()	By default, TenantServices will create a vendor catalog upon notice of a new vendor being created.
String	getName()	A unique name for the vendor.
Contact	getPrimaryContact()	The primary contact associated with this vendor.
String	getVendorRef()	A unique reference key used throughout the system to associate data to the vendor.
int	hashCode()
void	setAddress(Address address)	The primary address associated with this vendor.
void	setAdminUser(AdminUserInfo adminUser)	User information for an admin user that is to be created to manage this vendor.
void	setDefaultCurrency(String defaultCurrency)	By default, TenantServices will create a vendor catalog upon notice of a new vendor being created.
void	setDefaultLocale(String defaultLocale)	By default, TenantServices will create a vendor catalog upon notice of a new vendor being created.
void	setName(String name)	A unique name for the vendor.
void	setPrimaryContact(Contact primaryContact)	The primary contact associated with this vendor.
void	setVendorRef(String vendorRef)	A unique reference key used throughout the system to associate data to the vendor.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

VendorCreationRequest

public VendorCreationRequest()

Method Details

getName

public String getName()

A unique name for the vendor.

Returns:

a unique name for the vendor

getVendorRef

public String getVendorRef()

A unique reference key used throughout the system to associate data to the vendor. This cannot be changed once set.

Returns:

a unique reference key for the vendor

getAddress

public Address getAddress()

The primary address associated with this vendor.

Returns:

The primary address associated with this vendor.

getPrimaryContact

public Contact getPrimaryContact()

The primary contact associated with this vendor.

Returns:

The primary contact associated with this vendor.

getAdminUser

public AdminUserInfo getAdminUser()

User information for an admin user that is to be created to manage this vendor.

Returns:

User information for an admin user.

getDefaultLocale

public String getDefaultLocale()

By default, TenantServices will create a vendor catalog upon notice of a new vendor being created. This field is used to inform the default locale to set on that catalog.

This must match a valid IETF BCP 47 language tag format.

Returns:

the IETF BCP 47 language tag of the locale

See Also:

• Locale.Builder.setLanguageTag(String)

getDefaultCurrency

public String getDefaultCurrency()

By default, TenantServices will create a vendor catalog upon notice of a new vendor being created. This field is used to inform the default currency to set on that catalog.

Returns:

the ISO 4217 code of the currency

setName

public void setName(String name)

A unique name for the vendor.

Parameters:

name - a unique name for the vendor

setVendorRef

public void setVendorRef(String vendorRef)

A unique reference key used throughout the system to associate data to the vendor. This cannot be changed once set.

Parameters:

vendorRef - a unique reference key for the vendor

setAddress

public void setAddress(Address address)

The primary address associated with this vendor.

Parameters:

address - The primary address associated with this vendor.

setPrimaryContact

public void setPrimaryContact(Contact primaryContact)

The primary contact associated with this vendor.

Parameters:

primaryContact - The primary contact associated with this vendor.

setAdminUser

public void setAdminUser(AdminUserInfo adminUser)

User information for an admin user that is to be created to manage this vendor.

Parameters:

adminUser - User information for an admin user.

setDefaultLocale

public void setDefaultLocale(String defaultLocale)

By default, TenantServices will create a vendor catalog upon notice of a new vendor being created. This field is used to inform the default locale to set on that catalog.

This must match a valid IETF BCP 47 language tag format.

Parameters:

defaultLocale - the IETF BCP 47 language tag of the locale

See Also:

• Locale.Builder.setLanguageTag(String)

setDefaultCurrency

public void setDefaultCurrency(String defaultCurrency)

By default, TenantServices will create a vendor catalog upon notice of a new vendor being created. This field is used to inform the default currency to set on that catalog.

Parameters:

defaultCurrency - the ISO 4217 code of the currency

equals

public boolean equals(Object o)

Overrides:

equals in class Object

canEqual

protected boolean canEqual(Object other)

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object