Serialized Form

Package com.broadleafcommerce.vendor.domain

Class com.broadleafcommerce.vendor.domain.Address

class Address extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

additionalAttributes

Map<String,Object> additionalAttributes

Map holding any additional attributes passed in the request not matching any defined properties.

addressLine1

String addressLine1

Primary address information, typically street name and building number.

addressLine2

String addressLine2

Secondary address information, like apartment, suite, or unit number.

addressLine3

String addressLine3

Tertiary address information, typically for international addresses.

city

String city

The city, town or village of this address.

companyName

String companyName

The name of the company at this address.

country

String country

The country for this address.

county

String county

The county of this address.

phoneFax

Phone phoneFax

The fax number for this address.

phonePrimary

Phone phonePrimary

The primary phone number for this address.

phoneSecondary

Phone phoneSecondary

The secondary phone number for this address.

postalCode

String postalCode

Postal code or ZIP code for this address.

stateProvinceRegion

String stateProvinceRegion

The state, province or region of this address.

Class com.broadleafcommerce.vendor.domain.Attribute

class Attribute extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

contextState

com.broadleafcommerce.data.tracking.core.EmbeddedContextState contextState

A subset of Tracking information to expose the context state for this object. This value is not persisted, and instead it is dynamically calculated and populated when the ChangeDetails for the parent object's entire attributes map are compared.

value

Object value

The value represented by this attribute. Attributes are generally placed on domain objects as a map of attribute names to attribute values: Map<String, Attribute>.

Class com.broadleafcommerce.vendor.domain.Contact

class Contact extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

address

Address address

The address of the contact.

emailAddress

String emailAddress

The email address of the contact.

fullName

String fullName

The combined names of the contact. It is considered better UX to use a full name field in place of separate first and last name fields.

Class com.broadleafcommerce.vendor.domain.Phone

class Phone extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

countryCode

String countryCode

The country calling code that acts as a prefix to the main telephone number.

extension

String extension

The internal extension for this phone.

phoneNumber

String phoneNumber

The telephone number, including the area code.

Class com.broadleafcommerce.vendor.domain.Vendor

class Vendor extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

additionalContacts

List<Contact> additionalContacts

Additional contacts associated with the vendor.

address

Address address

The primary address associated with this vendor.

attributes

Map<String,Attribute> attributes

Dynamic attributes that are a part of the vendor. This is an admin-entered concept

contextState

com.broadleafcommerce.data.tracking.core.filtering.business.domain.ContextState contextState

A subset of Tracking information to expose the context state for this object.

defaultCurrency

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.

defaultLocale

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.

See Also:

• Locale.Builder.setLanguageTag(String)

id

String id

The context ID of the vendor.

name

String name

A unique name for the vendor.

primaryContact

Contact primaryContact

The primary contact associated with this vendor.

vendorRef

String vendorRef

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

Package com.broadleafcommerce.vendor.domain.request

Class com.broadleafcommerce.vendor.domain.request.AdminUserInfo

class AdminUserInfo extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

emailAddress

String emailAddress

An email address to create an admin user for assigned to this vendor.

name

String name

The name for the new admin user.

password

String password

The desired password for the new admin user.

Class com.broadleafcommerce.vendor.domain.request.VendorCreationRequest

class VendorCreationRequest extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

address

Address address

The primary address associated with this vendor.

adminUser

AdminUserInfo adminUser

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

defaultCurrency

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.

defaultLocale

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.

See Also:

• Locale.Builder.setLanguageTag(String)

name

String name

A unique name for the vendor.

primaryContact

Contact primaryContact

The primary contact associated with this vendor.

vendorRef

String vendorRef

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

Package com.broadleafcommerce.vendor.provider.jpa.domain

Class com.broadleafcommerce.vendor.provider.jpa.domain.JpaAttribute

class JpaAttribute extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

value

Object value

See Also:

• Attribute.getValue()

Class com.broadleafcommerce.vendor.provider.jpa.domain.JpaVendor

class JpaVendor extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

_id

String _id

additionalContacts

List<Contact> additionalContacts

See Also:

• Vendor.getAdditionalContacts()

address

Address address

See Also:

• Vendor.getAddress()

attributes

Map<String,JpaAttribute> attributes

See Also:

• Vendor.getAttributes()

contextId

String contextId

See Also:

• Vendor.getId()

defaultCurrency

String defaultCurrency

defaultLocale

String defaultLocale

name

String name

See Also:

• Vendor.getName()

primaryContact

Contact primaryContact

See Also:

• Vendor.getPrimaryContact()

timestamp

Instant timestamp

Temporal state describing the time at which this item was last updated. Relates to the Temporal interface and is primarily used during consumption of messages regarding changes in state to this domain. For example, a service consuming a change notification for this domain can compare the current persisted timestamp to this timestamp to determine if it already has a newer version, in which case, it can ignore. This is primarily a measure to ensure that ordering is not required for messages related to state change.

tracking

com.broadleafcommerce.data.tracking.jpa.filtering.domain.TenantJpaTracking tracking

See Also:

• TenantJpaTracking

vendorRef

String vendorRef

See Also:

• Vendor.getVendorRef()