com.commercetools.sync.commons.helpers

Interface GenericCustomActionBuilder<T extends io.sphere.sdk.models.Resource<T>>

Type Parameters:

T - the type of the resource to create update actions for.

All Known Implementing Classes:

AssetCustomActionBuilder, AssetCustomActionBuilder, CategoryCustomActionBuilder, ChannelCustomActionBuilder, InventoryCustomActionBuilder, PriceCustomActionBuilder

public interface GenericCustomActionBuilder<T extends io.sphere.sdk.models.Resource<T>>

A generic custom update action builder that creates update actions that are of the same type as the Generic type T provided by the subclass of this abstract class. For example, if T is a Category then all the methods would build custom update actions of the type Category

Method Summary

Modifier and Type	Method and Description
io.sphere.sdk.commands.UpdateAction<T>	buildRemoveCustomTypeAction(java.lang.Integer variantId, java.lang.String objectId) Creates a CTP "setCustomType" update action on the given resource T that removes the custom type set on the given resource T.
io.sphere.sdk.commands.UpdateAction<T>	buildSetCustomFieldAction(java.lang.Integer variantId, java.lang.String objectId, java.lang.String customFieldName, com.fasterxml.jackson.databind.JsonNode customFieldValue) Creates a CTP "setCustomField" update action on the given resource T that updates a custom field with customFieldName and a customFieldValue on the given resource T.
io.sphere.sdk.commands.UpdateAction<T>	buildSetCustomTypeAction(java.lang.Integer variantId, java.lang.String objectId, java.lang.String customTypeId, java.util.Map<java.lang.String,com.fasterxml.jackson.databind.JsonNode> customFieldsJsonMap) Creates a CTP "setCustomType" update action on the given resource T.

Method Detail

buildRemoveCustomTypeAction

@Nonnull
io.sphere.sdk.commands.UpdateAction<T> buildRemoveCustomTypeAction(@Nullable
                                                                            java.lang.Integer variantId,
                                                                            @Nullable
                                                                            java.lang.String objectId)

Creates a CTP "setCustomType" update action on the given resource T that removes the custom type set on the given resource T. If the resource that has the custom fields is a secondary resource (e.g. price or asset) and not a primary resource (e.g Category, Product, Channel, etc..), the variantId and the objectId will be used to identify this secondary resource within its container.

Parameters:

variantId - an optional field which could be used to identify the variant that holds the a resource (e.g. asset) which has the custom fields.

objectId - an optional field which could be used to identify the id of the resource (e.g. asset, price, etc..) which has the custom fields.

Returns:

a setCustomType update action that removes the custom type from the resource it's requested on.

buildSetCustomTypeAction

@Nonnull
io.sphere.sdk.commands.UpdateAction<T> buildSetCustomTypeAction(@Nullable
                                                                         java.lang.Integer variantId,
                                                                         @Nullable
                                                                         java.lang.String objectId,
                                                                         @Nonnull
                                                                         java.lang.String customTypeId,
                                                                         @Nullable
                                                                         java.util.Map<java.lang.String,com.fasterxml.jackson.databind.JsonNode> customFieldsJsonMap)

Creates a CTP "setCustomType" update action on the given resource T. If the resource that has the custom fields is a secondary resource (e.g. Price or asset) and not a primary resource (e.g Category, Product, Channel, etc..), the variantId and the objectId will be used to identify this secondary resource within its container.

Parameters:

variantId - an optional field which could be used to identify the variant that holds the a resource (e.g. asset) which has the custom fields.

objectId - an optional field which could be used to identify the id of the resource (e.g. asset, price, etc..) which has the custom fields.

customTypeId - the id of the new custom type.

customFieldsJsonMap - the custom fields map of JSON values.

Returns:

a setCustomType update action of the type of the resource it's requested on.

buildSetCustomFieldAction

@Nonnull
io.sphere.sdk.commands.UpdateAction<T> buildSetCustomFieldAction(@Nullable
                                                                          java.lang.Integer variantId,
                                                                          @Nullable
                                                                          java.lang.String objectId,
                                                                          @Nullable
                                                                          java.lang.String customFieldName,
                                                                          @Nullable
                                                                          com.fasterxml.jackson.databind.JsonNode customFieldValue)

Creates a CTP "setCustomField" update action on the given resource T that updates a custom field with customFieldName and a customFieldValue on the given resource T. If the resource that has the custom fields is a secondary resource (e.g. Price or asset) and not a primary resource (e.g Category, Product, Channel, etc..), the variantId and the objectId will be used to identify this secondary resource within its container.

Parameters:

variantId - an optional field which could be used to identify the variant that holds the a resource (e.g. asset) which has the custom fields.

objectId - an optional field which could be used to identify the id of the resource (e.g. asset, price, etc..) which has the custom fields.

customFieldName - the name of the custom field to update.

customFieldValue - the new JSON value of the custom field.

Returns:

a setCustomField update action on the provided field name, with the provided value on the resource it's requested on.