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

Interface AugmentationProcessor

All Known Implementing Classes:

FieldAugmentationProcessor, GroupAugmentationProcessor, SelectFieldAugmentationProcessor

public interface AugmentationProcessor

The processor that is used to process AugmentationChangeType.INSERT and AugmentationChangeType.PATCH operations.

Author:

Dima Myroniuk (dmyroniuk)

Method Summary

Modifier and Type	Method	Description
boolean	canHandleInsert(com.broadleafcommerce.metadata.dsl.core.Component<?> parent, Augmentation augmentation)	Check if this service can process the augmentation for the AugmentationChangeType.INSERT change.
boolean	canHandleUpdate(com.broadleafcommerce.metadata.dsl.core.Component<?> component, Augmentation augmentation)	Check if this service can process the augmentation for the AugmentationChangeType.PATCH change.
com.broadleafcommerce.metadata.dsl.core.Component<?>	processInsert(com.broadleafcommerce.metadata.dsl.core.Component<?> parent, Augmentation augmentation)	Adds the new component to the specified parent component.
com.broadleafcommerce.metadata.dsl.core.Component<?>	processUpdate(com.broadleafcommerce.metadata.dsl.core.Component<?> component, Augmentation augmentation)	Updates the specified component.

Method Detail

canHandleInsert

boolean canHandleInsert(com.broadleafcommerce.metadata.dsl.core.Component<?> parent,
                        Augmentation augmentation)

Check if this service can process the augmentation for the AugmentationChangeType.INSERT change.

Parameters:

parent - the parent component to insert the augmented component

augmentation - the augmentation to apply

Returns:

true if this processor can process the augmentation

canHandleUpdate

boolean canHandleUpdate(com.broadleafcommerce.metadata.dsl.core.Component<?> component,
                        Augmentation augmentation)

Check if this service can process the augmentation for the AugmentationChangeType.PATCH change.

Parameters:

component - the component to update with the specified augmentation

augmentation - the augmentation to apply

Returns:

true if this processor can process the augmentation

processInsert

com.broadleafcommerce.metadata.dsl.core.Component<?> processInsert(com.broadleafcommerce.metadata.dsl.core.Component<?> parent,
                                                                   Augmentation augmentation)

Adds the new component to the specified parent component.

Parameters:

parent - the parent component to insert the new component

augmentation - the augmentation to apply

Returns:

the inserted component

processUpdate

com.broadleafcommerce.metadata.dsl.core.Component<?> processUpdate(com.broadleafcommerce.metadata.dsl.core.Component<?> component,
                                                                   Augmentation augmentation)

Updates the specified component.

Parameters:

component - the component to update

augmentation - the augmentation to apply

Returns:

the updated component