com.commercetools.sync.channels.helpers

Class ChannelCustomActionBuilder

java.lang.Object

com.commercetools.sync.channels.helpers.ChannelCustomActionBuilder

All Implemented Interfaces:

GenericCustomActionBuilder<io.sphere.sdk.channels.Channel>

public class ChannelCustomActionBuilder
extends java.lang.Object
implements GenericCustomActionBuilder<io.sphere.sdk.channels.Channel>

Constructor Summary

Constructors

Constructor and Description
ChannelCustomActionBuilder()

Method Summary

Modifier and Type	Method and Description
io.sphere.sdk.commands.UpdateAction<io.sphere.sdk.channels.Channel>	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<io.sphere.sdk.channels.Channel>	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<io.sphere.sdk.channels.Channel>	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.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ChannelCustomActionBuilder

public ChannelCustomActionBuilder()

Method Detail

buildRemoveCustomTypeAction

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

Description copied from interface: GenericCustomActionBuilder

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.

Specified by:

buildRemoveCustomTypeAction in interface GenericCustomActionBuilder<io.sphere.sdk.channels.Channel>

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
public io.sphere.sdk.commands.UpdateAction<io.sphere.sdk.channels.Channel> 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)

Description copied from interface: GenericCustomActionBuilder

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.

Specified by:

buildSetCustomTypeAction in interface GenericCustomActionBuilder<io.sphere.sdk.channels.Channel>

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
public io.sphere.sdk.commands.UpdateAction<io.sphere.sdk.channels.Channel> buildSetCustomFieldAction(@Nullable
                                                                                                              java.lang.Integer variantId,
                                                                                                              @Nullable
                                                                                                              java.lang.String objectId,
                                                                                                              @Nullable
                                                                                                              java.lang.String customFieldName,
                                                                                                              @Nullable
                                                                                                              com.fasterxml.jackson.databind.JsonNode customFieldValue)

Description copied from interface: GenericCustomActionBuilder

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.

Specified by:

buildSetCustomFieldAction in interface GenericCustomActionBuilder<io.sphere.sdk.channels.Channel>

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.