Serialized Form

Package com.broadleafcommerce.recommendationengine.domain

Class com.broadleafcommerce.recommendationengine.domain.CatalogItem

class CatalogItem extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

activeEndDate

Instant activeEndDate

End when this product is not longer active. Unset indicates that it is always active.

See Also:

• CatalogItem.isActive()

activeStartDate

Instant activeStartDate

attributes

Map<String,Object> attributes

Dynamic attributes that are a part of the product. This is an admin-centered concept

catalogItemContextId

String catalogItemContextId

Context id from catalog (product)

externalId

String externalId

This is an arbitrary ID, typically assigned by or used by 1st or 3rd party systems that are not Broadleaf.

id

String id

Context id

individuallySold

boolean individuallySold

If this product or any of its variants can be sold individually in the store, or if they must be apart of another product as an add-on. Usually if a product is not individually sold then it should also not show up in search.

This defaults to true.

See Also:

• CatalogItem.searchable

name

String name

numericId

Long numericId

online

boolean online

Whether or not this product should be visible at all in the store. A product that is offline is not searchable, visible, or purchasable. A product that is offline behaves as if it falls outside the active date range. It is not returned from storefront requests by default.

Defaults to true

searchable

boolean searchable

Whether or not this product shows up in search. Usually this matches whether or not the product is CatalogItem.individuallySold

This defaults to true

sku

String sku

upc

String upc

Class com.broadleafcommerce.recommendationengine.domain.CatalogItemRef

class CatalogItemRef extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

id

String id

name

String name

Class com.broadleafcommerce.recommendationengine.domain.Customer

class Customer extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

active

boolean active

Is this customer active? Inactive customers can be thought of as "disabled" and will not be able to login. A customer set to inactive must be manually re-activated.

Note: If manually setting this to false (e.g. via a direct database update), the auth user record (JpaUser#active in the auth database) must also be set to false.

See also Customer.locked

attributes

Map<String,Object> attributes

Dynamic attributes that are a part of the customer. This is an admin-entered field.

contextState

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

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

defaultAccountId

String defaultAccountId

The default account for the customer. If set, the customer will automatically have this account selected on login.

defaultCommunicationPreference

String defaultCommunicationPreference

The default communication preference of the customer.

email

String email

The email address of the customer.

externalId

String externalId

The id that associates this user with an external system.

firstName

String firstName

The first name of the customer, if the fullName is not being used for the customer.

fullName

String fullName

The full name of the customer, if the component parts firstName, middleName, and lastName are not being used to comprise the full name.

id

String id

The context ID of the customer.

lastName

String lastName

The last name of the customer, if the fullName is not being used for the customer.

locked

boolean locked

Is this user locked? A user may be locked due to too many failed login attempts. Note that, depending on user lock configuration, this may have no effect. If permanently disabling a customer is desired, the Customer.active flag should be used instead.

middleName

String middleName

The middle name of the customer, if the fullName is not being used for the customer.

numericId

Long numericId

The ID of the customer.

specialType

String specialType

The type of the customer, if it's in a special circumstance.

taxId

String taxId

The tax id for this customer

username

String username

The username of the customer, used to log in.

vatRegistrationId

String vatRegistrationId

Optional VAT registration ID.

Class com.broadleafcommerce.recommendationengine.domain.ImplicitRating

class ImplicitRating extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

itemId

int itemId

rating

float rating

userId

int userId

Class com.broadleafcommerce.recommendationengine.domain.Purchase

class Purchase extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

attributes

Map<String,Object> attributes

Miscellaneous attributes for this order.

cartCreateDate

Instant cartCreateDate

The date that the originating cart was first created.

cartId

String cartId

The context ID of the original cart for this order.

checkoutRequestId

String checkoutRequestId

The id of the latest checkout request for the originating cart.

This is typically the latest checkout request id if there were multiple checkout submissions for the cart.

contextState

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

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

customerId

String customerId

The ID of the customer that owns this order.

emailAddress

String emailAddress

The customer's email address.

id

String id

The context ID of the purchase.

locale

Locale locale

The locale for this purchase. Used to determine what locale this purchase was in for translations and other location-based functionality.

orderNumber

String orderNumber

The unique number associated with this Purchase. Typically, this is generated and set on order submission. Used for record keeping and communicating with the customer instead of just using Purchase.getId() since that exposes unwanted information about your database.

orderPricing

com.broadleafcommerce.order.client.domain.OrderPricing orderPricing

Embedded container for all pricing information on this order.

purchaseItems

List<PurchaseItem> purchaseItems

Items that are contained within this order. Typically represents a good or service that the customer is purchasing.

status

String status

The status of this order.

submitDate

Instant submitDate

The date that this purchase was submitted.

Class com.broadleafcommerce.recommendationengine.domain.PurchaseItem

class PurchaseItem extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

attributes

Map<String,Object> attributes

Miscellaneous attributes for this item.

brandId

String brandId

The id to the corresponding data driven enum for this item's product's brand.

categoryIds

Set<String> categoryIds

The ids to the corresponding categories for this item's product.

id

String id

The context ID of the purchase.

merchandisingContext

String merchandisingContext

Defines the merchandising context of the item to signify where it is added from.

This field is intended to be used for items added from SELECTOR products, which allows for the possibility of targeting the items for discounts based on the fact that they came from the SELECTOR product.

merchandisingTypeId

String merchandisingTypeId

The id to the corresponding data driven enum for this item's product's merchandising type.

name

String name

The name of this item. Typically derived from the product or sku name.

priceListId

String priceListId

The id of the price list used to get the pricing for this PurchaseItem.

productId

String productId

The id to the corresponding product for this item.

productTags

List<String> productTags

The list of simple labels used to categorize the corresponding product for this item.

purchase

Purchase purchase

The owning purchase of this item.

quantity

int quantity

The number of this item in the Purchase.

sku

String sku

Represents a SKU code, similar to productId or variantId, except this is a unified, unique concept across both products and variants.

targetDemographicId

String targetDemographicId

The id to the corresponding data driven enum for this item's product's target demographic.

unitPrice

javax.money.MonetaryAmount unitPrice

The individual unit price for an PurchaseItem.

uri

String uri

The navigable uri of the corresponding catalog entry (e.g. product) for this purchase item.

variantId

String variantId

The id to the corresponding variant for this item.

vendorRef

String vendorRef

A reference to the corresponding vendor for this item.

Class com.broadleafcommerce.recommendationengine.domain.TrainingRequest

class TrainingRequest extends Object implements Serializable

Serialized Fields

dbProperties

com.broadleafcommerce.recommendationengine.domain.TrainingRequest.TrainingDBProperties dbProperties

modelPath

String modelPath

numberOfRecommendations

int numberOfRecommendations

type

String type

Class com.broadleafcommerce.recommendationengine.domain.TrainingRequest.TrainingDBProperties

class TrainingDBProperties extends Object implements Serializable

Serialized Fields

driverClass

String driverClass

password

String password

url

String url

username

String username

Class com.broadleafcommerce.recommendationengine.domain.UserRecommendation

class UserRecommendation extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

activeEndDate

Instant activeEndDate

activeStartDate

Instant activeStartDate

attributes

Map<String,Object> attributes

contextState

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

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

id

String id

items

List<UserRecommendationItem> items

name

String name

type

String type

userId

String userId

Generally refers to the numerical Customer Reference Identifier which is used by the ALS training model to provide recommendations. JpaCustomerReference.getNumericId()

Class com.broadleafcommerce.recommendationengine.domain.UserRecommendationItem

class UserRecommendationItem extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

catalogItem

CatalogItem catalogItem

id

String id

itemRef

CatalogItemRef itemRef

rank

int rank

userRecommendation

UserRecommendation userRecommendation

Package com.broadleafcommerce.recommendationengine.exception

Exception com.broadleafcommerce.recommendationengine.exception.ProviderApiException

class ProviderApiException extends RuntimeException implements Serializable

Serialized Fields

receivedException

org.springframework.web.reactive.function.client.WebClientResponseException receivedException

The received error.

Package com.broadleafcommerce.recommendationengine.provider.jpa.domain

Class com.broadleafcommerce.recommendationengine.provider.jpa.domain.JpaCatalogItem

class JpaCatalogItem extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

activeEndDate

Instant activeEndDate

activeStartDate

Instant activeStartDate

attributes

Map<String,Object> attributes

businessType

String businessType

catalogItemType

String catalogItemType

contextId

String contextId

externalId

String externalId

individuallySold

boolean individuallySold

name

String name

numberOfReviews

Integer numberOfReviews

numericId

long numericId

online

boolean online

rating

BigDecimal rating

ratingUnits

String ratingUnits

searchable

boolean searchable

sku

String sku

tracking

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

upc

String upc

Class com.broadleafcommerce.recommendationengine.provider.jpa.domain.JpaCustomerReference

class JpaCustomerReference extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

active

boolean active

attributes

Map<String,Object> attributes

See Also:

• Customer.getAttributes()

contextId

String contextId

defaultAccountId

String defaultAccountId

defaultCommunicationPreference

String defaultCommunicationPreference

email

String email

See Also:

• Customer.getEmail()

externalId

String externalId

See Also:

• Customer.getExternalId()

firstName

String firstName

See Also:

• Customer.getFirstName()

fullName

String fullName

See Also:

• Customer.getFullName()

lastName

String lastName

See Also:

• Customer.getLastName()

locked

boolean locked

middleName

String middleName

See Also:

• Customer.getMiddleName()

numericId

long numericId

specialType

String specialType

See Also:

• Customer.getSpecialType()

taxId

String taxId

The tax id for this customer

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.CustomerContextJpaTracking tracking

username

String username

See Also:

• Customer.getUsername()

vatRegistrationId

String vatRegistrationId

Optional VAT registration ID for this customer.

Class com.broadleafcommerce.recommendationengine.provider.jpa.domain.JpaPurchase

class JpaPurchase extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

adjustmentsTotal

BigDecimal adjustmentsTotal

attributes

Map<String,Object> attributes

cartCreateDate

Instant cartCreateDate

cartId

String cartId

checkoutRequestId

String checkoutRequestId

contextId

String contextId

The jpa primary key.

currency

javax.money.CurrencyUnit currency

customerId

String customerId

emailAddress

String emailAddress

feesTotal

BigDecimal feesTotal

fulfillmentTotal

BigDecimal fulfillmentTotal

includedTaxAmount

BigDecimal includedTaxAmount

locale

Locale locale

orderNumber

String orderNumber

purchaseItems

List<JpaPurchaseItem> purchaseItems

status

String status

submitDate

Instant submitDate

subtotal

BigDecimal subtotal

total

BigDecimal total

totalTax

BigDecimal totalTax

tracking

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

See Also:

• ApplicationJpaTracking

Class com.broadleafcommerce.recommendationengine.provider.jpa.domain.JpaPurchaseItem

class JpaPurchaseItem extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

attributes

Map<String,Object> attributes

brandId

String brandId

categoryIds

Set<String> categoryIds

contextId

String contextId

The jpa primary key.

currency

javax.money.CurrencyUnit currency

merchandisingContext

String merchandisingContext

merchandisingTypeId

String merchandisingTypeId

name

String name

priceListId

String priceListId

productId

String productId

productTags

List<String> productTags

purchase

JpaPurchase purchase

quantity

int quantity

sku

String sku

targetDemographicId

String targetDemographicId

unitPrice

BigDecimal unitPrice

uri

String uri

variantId

String variantId

vendorRef

String vendorRef

Class com.broadleafcommerce.recommendationengine.provider.jpa.domain.JpaUserRecommendation

class JpaUserRecommendation extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

attributes

Map<String,Object> attributes

contextId

String contextId

The jpa primary key.

items

List<JpaUserRecommendationItem> items

name

String name

tracking

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

See Also:

• ApplicationJpaTracking

type

String type

userId

String userId

Class com.broadleafcommerce.recommendationengine.provider.jpa.domain.JpaUserRecommendationItem

class JpaUserRecommendationItem extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

contextId

String contextId

The jpa primary key.

itemId

String itemId

itemName

String itemName

rank

int rank

userRecommendation

JpaUserRecommendation userRecommendation

Package com.broadleafcommerce.recommendationengine.service

Class com.broadleafcommerce.recommendationengine.service.DefaultSparkRecommendationService

class DefaultSparkRecommendationService extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

catalogItemService

CatalogItemService<CatalogItem> catalogItemService

customerService

CustomerService<Customer> customerService

recommendationEngineProperties

RecommendationEngineProperties recommendationEngineProperties

typeFactory

com.broadleafcommerce.common.extension.TypeFactory typeFactory

userRecommendationService

UserRecommendationService<UserRecommendation> userRecommendationService

Class com.broadleafcommerce.recommendationengine.service.DefaultSparkRecommendationService.UserRecommendationData

class UserRecommendationData extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

recommendations

List<DefaultSparkRecommendationService.UserRecommendationData.Recommendation> recommendations

userId

int userId

Class com.broadleafcommerce.recommendationengine.service.DefaultSparkRecommendationService.UserRecommendationData.Recommendation

class Recommendation extends Object implements Serializable

Serialized Fields

itemId

int itemId

rating

float rating

Package com.broadleafcommerce.recommendationengine.service.autoconfigure

Class com.broadleafcommerce.recommendationengine.service.autoconfigure.RecommendationEngineProperties

class RecommendationEngineProperties extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

baseModelPath

String baseModelPath

useCustomerUsernameAsUserId

boolean useCustomerUsernameAsUserId

Package com.broadleafcommerce.recommendationengine.service.messaging.domain

Class com.broadleafcommerce.recommendationengine.service.messaging.domain.CustomerModifiedEvent

class CustomerModifiedEvent extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

contextInfo

com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo

The ContextInfo derived from the original request containing tenant and sandbox info.

customers

List<Customer> customers

The customers that have been created / modified / deleted

operationType

String operationType

The type of operation that has occurred ("CREATE", "UPDATE" or "DELETE")

Class com.broadleafcommerce.recommendationengine.service.messaging.domain.PurchaseEvent

class PurchaseEvent extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

contextInfo

com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo

The ContextInfo derived from the original request containing tenant and sandbox info.

links

Map<String,OrderLink> links

The links that can be used to read an additional data for the event if needed.

Package com.broadleafcommerce.recommendationengine.web.endpoint.domain

Class com.broadleafcommerce.recommendationengine.web.endpoint.domain.RecommendationRequest

class RecommendationRequest extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

numberOfRecommendations

int numberOfRecommendations

type

String type

Package com.broadleafcommerce.recommendationengine.web.endpoint.exception

Exception com.broadleafcommerce.recommendationengine.web.endpoint.exception.InvalidRecommendationException

class InvalidRecommendationException extends Exception implements Serializable

serialVersionUID:

1L