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.

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

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.

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.

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

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

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

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