Serialized Form

Package com.broadleafcommerce.metadata.core.domain

Class com.broadleafcommerce.metadata.core.domain.Augmentation

class Augmentation extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

changeType

AugmentationChangeType changeType

The type of change this represents.

See Also:

• for the enumerated options

componentClassifier

String componentClassifier

The classifier of the component.

componentType

String componentType

The type of the component.

containerKey

String containerKey

Reference to the top-level Component.getAugmentationKey() in the root-level component

id

String id

jsonPayload

String jsonPayload

The json representation of the component for this augmentation operation. Only non-null when Augmentation.changeType is AugmentationChangeType.INSERT or AugmentationChangeType.PATCH

targetKey

String targetKey

The augmentation key of the child within the container that is the target of the augment

targetLabel

com.broadleafcommerce.metadata.i18n.InternationalizedMessage targetLabel

This is the label of the target component and is NOT persisted with the augmentation. It is defined at augmentation time.

timestamp

Instant timestamp

The timestamp of when this was created. Used for determining the order of operations when applying augmentations.

Class com.broadleafcommerce.metadata.core.domain.Route

class Route extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

componentKey

String componentKey

Key of the component to render at Route.path.

componentName

String componentName

Name of the component.

id

String id

Id of the route.

path

String path

Path matching the browser location to match to render the component.

predicates

List<RoutePredicate> predicates

Predicates that restrict access to the route.

Since:

Admin Services 2.3.0, Release Train 2.2.2

priority

int priority

The order to sort the route by. By default, routes are ordered to be last unless this field is defined explicitly.

Since:

Admin Services 2.3.0, Release Train 2.2.2

scopeMatchType

String scopeMatchType

Controls how the scopes are used to filter the route's accessibility. The default is DefaultRouteScopeMatchType.ANY.

Since:

Admin Service 2.1.4, Release Train 2.1.5

See Also:

• DefaultRouteScopeMatchType

scopes

List<String> scopes

Security scopes needed for a user to access the route.

Class com.broadleafcommerce.metadata.core.domain.RouteComponent

class RouteComponent extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

adminLabel

String adminLabel

A label used in the admin UI to distinguish this route component from others. For example, this can be set to differentiate between multiple variations of a product management view that can be augmented through a BusinessType, e.g., a super admin view and a shop manager view.

Since:

Admin Service 2.1.4, Release Train 2.1.5

businessTypeKey

String businessTypeKey

If this route is generated from a Business Type, then this holds the types key.

componentKey

String componentKey

The key of the component. This is typically in the form service:entity:entity-type: catalog:product:standard.

componentName

String componentName

Name of the component.

componentType

String componentType

The type of route component.

See Also:

• DefaultRouteComponentType

id

String id

parentComponentKey

String parentComponentKey

The key of the component's parent component. This is typically a view component like catalog:product:browse or catalog:product:standard:create.

Class com.broadleafcommerce.metadata.core.domain.RoutePredicate

class RoutePredicate extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

arguments

List<String> arguments

The list of arguments to check when this route predicate is evaluated

name

String name

The descriptive name of the predicate to be applied onto a route

predicateMatchType

String predicateMatchType

Controls how the predicates are used to filter the route's accessibility. The default is DefaultRoutePredicateMatchType.ALL.

type

String type

The predicate type which can determine the complexity of its evaluation or application

Package com.broadleafcommerce.metadata.core.service.messaging.augmentation

Class com.broadleafcommerce.metadata.core.service.messaging.augmentation.AugmentationModifiedEvent

class AugmentationModifiedEvent extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

augmentation

Augmentation augmentation

The augmentation that has been created / modified

contextInfo

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

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

Package com.broadleafcommerce.metadata.core.service.messaging.businessType.dto

Class com.broadleafcommerce.metadata.core.service.messaging.businessType.dto.BusinessType

class BusinessType extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

attributes

Map<String,Object> attributes

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

characteristics

List<BusinessTypeCharacteristic> characteristics

Represents characteristics associated to the BusinessType.

Since:

Admin Service 2.3.0, Release Train 2.3.0

customFields

Map<String,BusinessTypeField> customFields

Represents fields that are net new to the entity.

description

String description

A friendly description of the type.

fields

Map<String,BusinessTypeField> fields

Represent fields that override the default metadata for an entity such as changing a product's name's field label.

id

String id

Id of the business type.

name

String name

Name of the type. This is displayed to users.

typeKey

String typeKey

Key for the type. This is used in business logic.

Class com.broadleafcommerce.metadata.core.service.messaging.businessType.dto.BusinessTypeCharacteristic

class BusinessTypeCharacteristic extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

characteristic

Characteristic characteristic

The Characteristic associated with this business type.

displayOrder

Integer displayOrder

The display order of the characteristic.

order

Integer order

The display order on the admin form.

targetKey

Map<String,String> targetKey

Augmentation target key.

Class com.broadleafcommerce.metadata.core.service.messaging.businessType.dto.BusinessTypeField

class BusinessTypeField extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

attributes

Map<String,Object> attributes

Additional arbitrary attributes.

changeType

AugmentationChangeType changeType

The change type for this field.

classifier

String classifier

The fields classifier, typically either Field or External.

defaultValue

Object defaultValue

The default value for the field.

hidden

boolean hidden

Whether the field should be hidden in admin forms.

label

String label

The display label for this field.

name

String name

The name of the field. This is used in the business logic.

order

Integer order

The display order.

readOnly

boolean readOnly

Whether the field should be read-only in admin forms.

required

boolean required

Whether the field is required in admin forms.

showInQueryBuilder

boolean showInQueryBuilder

Whether the field should be included in the fields for Query Builders.

targetKey

String targetKey

Augmentation target key.

timestamp

Instant timestamp

The timestamp of the last update to this field.

type

String type

The type of component, e.g., STRING, DECIMAL, MONEY etc. See com.broadleafcommerce.metadata.dsl.core.extension.fields.FieldTypes.

validationSchema

ValidationSchema validationSchema

Validation rules to run against the field's value.

Class com.broadleafcommerce.metadata.core.service.messaging.businessType.dto.BusinessTypeModifiedEvent

class BusinessTypeModifiedEvent extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

businessType

BusinessType businessType

The augmentation that has been created / modified

contextInfo

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

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

entityType

String entityType

The type of entity that this business type is associated with

modificationType

String modificationType

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

Class com.broadleafcommerce.metadata.core.service.messaging.businessType.dto.Characteristic

class Characteristic extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

attributes

Map<String,Object> attributes

Additional custom attributes associated with extensions and complex value types, e.g., enum, variant option.

displayOrder

Integer displayOrder

Display order for the characteristic.

displayWidget

String displayWidget

The name of the custom component that renders this characteristic.

errorMessage

String errorMessage

The error message to display if the validation rule fails.

fieldName

String fieldName

Internal field name of the characteristic.

id

String id

Id of the characteristic.

maxCardinality

int maxCardinality

Maximum cardinality for the characteristic.

minCardinality

int minCardinality

Minimum cardinality for the characteristic.

name

String name

Name of the characteristic.

targetableInRuleBuilders

boolean targetableInRuleBuilders

Whether this characteristic should be targetable in rule-builders (e.g., by Offers and Content Items).

translatable

boolean translatable

Whether the values for this characteristic are translatable in the Admin UI.

validationRule

String validationRule

The validation rule to apply to the characteristic's value.

validationType

String validationType

The type of validation to apply to the characteristic's value.

valueType

String valueType

Value type for the characteristic.

Class com.broadleafcommerce.metadata.core.service.messaging.businessType.dto.ValidationMethod

class ValidationMethod extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

args

List<Object> args

Arguments to pass into the validation method.

message

String message

An error message to dispaly if the BusinessTypeField fails validation.

name

String name

Name of the method to use to validate a method. See com.broadleafcommerce.metadata.dsl.core.utils.ValidationMethods.

Class com.broadleafcommerce.metadata.core.service.messaging.businessType.dto.ValidationSchema

class ValidationSchema extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

methods

List<ValidationMethod> methods

The validation rules.

type

String type

The type of validation, e.g., STRING, NUMBER, BOOLEAN, etc. See com.broadleafcommerce.metadata.dsl.core.utils.ValidationSchemas.Types.

Package com.broadleafcommerce.metadata.core.service.messaging.businessType.exception

Exception com.broadleafcommerce.metadata.core.service.messaging.businessType.exception.BusinessTypeModifierHandlerException

class BusinessTypeModifierHandlerException extends RuntimeException implements Serializable

Package com.broadleafcommerce.metadata.core.service.processor

Exception com.broadleafcommerce.metadata.core.service.processor.ProcessAugmentationException

class ProcessAugmentationException extends RuntimeException implements Serializable

Package com.broadleafcommerce.metadata.provider.jpa.domain

Class com.broadleafcommerce.metadata.provider.jpa.domain.JpaAugmentation

class JpaAugmentation extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

changeType

String changeType

componentClassifier

String componentClassifier

componentType

String componentType

containerKey

String containerKey

contextId

String contextId

jsonPayload

String jsonPayload

targetKey

String targetKey

timestamp

Instant timestamp

tracking

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

See Also:

• ApplicationJpaTracking

Class com.broadleafcommerce.metadata.provider.jpa.domain.JpaRoute

class JpaRoute extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

componentKey

String componentKey

componentName

String componentName

contextId

String contextId

path

String path

predicates

List<RoutePredicate> predicates

Since:

Admin Services 2.3.0, Release Train 2.2.2

priority

Integer priority

Since:

Admin Services 2.3.0, Release Train 2.2.2

scopeMatchType

String scopeMatchType

See Also:

• Route.getScopeMatchType()

scopes

List<String> scopes

tracking

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

See Also:

• ApplicationJpaTracking

Class com.broadleafcommerce.metadata.provider.jpa.domain.JpaRouteComponent

class JpaRouteComponent extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

adminLabel

String adminLabel

See Also:

• RouteComponent.getAdminLabel()

businessTypeKey

String businessTypeKey

See Also:

• RouteComponent.getBusinessTypeKey()

componentKey

String componentKey

See Also:

• RouteComponent.getComponentKey()

componentName

String componentName

See Also:

• RouteComponent.getComponentName()

componentType

String componentType

See Also:

• RouteComponent.getComponentType()

contextId

String contextId

parentComponentKey

String parentComponentKey

See Also:

• RouteComponent.getParentComponentKey()

tracking

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

See Also:

• ApplicationJpaTracking

Package com.broadleafcommerce.metadata.route

Class com.broadleafcommerce.metadata.route.ComponentRoute

class ComponentRoute extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

componentId

String componentId

componentName

String componentName

exact

boolean exact

order

int order

path

String path

predicate

Predicate<org.springframework.web.context.request.WebRequest> predicate

scopeMatchType

String scopeMatchType

scopes

List<String> scopes

Package com.broadleafcommerce.metadata.web.endpoint.exception

Exception com.broadleafcommerce.metadata.web.endpoint.exception.MetadataMissingException

class MetadataMissingException extends RuntimeException implements Serializable

Package com.broadleafcommerce.metadata.web.mapping

Class com.broadleafcommerce.metadata.web.mapping.UnwrappingBeanSerializerWithTypeInformation

class UnwrappingBeanSerializerWithTypeInformation extends com.fasterxml.jackson.databind.ser.impl.UnwrappingBeanSerializer implements Serializable

serialVersionUID:

1L

Class com.broadleafcommerce.metadata.web.mapping.UnwrappingBeanSerializerWithTypeInformationModule

class UnwrappingBeanSerializerWithTypeInformationModule extends com.fasterxml.jackson.databind.module.SimpleModule implements Serializable

serialVersionUID:

1L