com.commercetools.sync.categories.utils

Class CategoryUpdateActionUtils

java.lang.Object

com.commercetools.sync.categories.utils.CategoryUpdateActionUtils

public final class CategoryUpdateActionUtils
extends java.lang.Object

Method Summary

Modifier and Type	Method and Description
static java.util.List<io.sphere.sdk.commands.UpdateAction<io.sphere.sdk.categories.Category>>	buildAssetsUpdateActions(io.sphere.sdk.categories.Category oldCategory, io.sphere.sdk.categories.CategoryDraft newCategory, CategorySyncOptions syncOptions) Compares the assets of a Category and a CategoryDraft and returns a list of UpdateAction<Category> as a result.
static java.util.Optional<io.sphere.sdk.commands.UpdateAction<io.sphere.sdk.categories.Category>>	buildChangeNameUpdateAction(io.sphere.sdk.categories.Category oldCategory, io.sphere.sdk.categories.CategoryDraft newCategory) Compares the LocalizedString names of a Category and a CategoryDraft and returns an UpdateAction<Category> as a result in an Optional.
static java.util.Optional<io.sphere.sdk.commands.UpdateAction<io.sphere.sdk.categories.Category>>	buildChangeOrderHintUpdateAction(io.sphere.sdk.categories.Category oldCategory, io.sphere.sdk.categories.CategoryDraft newCategory, CategorySyncOptions syncOptions) Compares the orderHint values of a Category and a CategoryDraft and returns an UpdateAction<Category> as a result in an Optional.
static java.util.Optional<io.sphere.sdk.commands.UpdateAction<io.sphere.sdk.categories.Category>>	buildChangeParentUpdateAction(io.sphere.sdk.categories.Category oldCategory, io.sphere.sdk.categories.CategoryDraft newCategory, CategorySyncOptions syncOptions) Compares the parents Reference<Category> of a Category and a CategoryDraft and returns an UpdateAction<Category> as a result in an Optional.
static java.util.Optional<io.sphere.sdk.commands.UpdateAction<io.sphere.sdk.categories.Category>>	buildChangeSlugUpdateAction(io.sphere.sdk.categories.Category oldCategory, io.sphere.sdk.categories.CategoryDraft newCategory) Compares the LocalizedString slugs of a Category and a CategoryDraft and returns an UpdateAction<Category> as a result in an Optional.
static java.util.Optional<io.sphere.sdk.commands.UpdateAction<io.sphere.sdk.categories.Category>>	buildSetDescriptionUpdateAction(io.sphere.sdk.categories.Category oldCategory, io.sphere.sdk.categories.CategoryDraft newCategory) Compares the LocalizedString descriptions of a Category and a CategoryDraft and returns an UpdateAction<Category> as a result in an Optional.
static java.util.Optional<io.sphere.sdk.commands.UpdateAction<io.sphere.sdk.categories.Category>>	buildSetExternalIdUpdateAction(io.sphere.sdk.categories.Category oldCategory, io.sphere.sdk.categories.CategoryDraft newCategory) Compares the externalId values of a Category and a CategoryDraft and returns an UpdateAction<Category> as a result in an Optional.
static java.util.Optional<io.sphere.sdk.commands.UpdateAction<io.sphere.sdk.categories.Category>>	buildSetMetaDescriptionUpdateAction(io.sphere.sdk.categories.Category oldCategory, io.sphere.sdk.categories.CategoryDraft newCategory) Compares the LocalizedString meta description of a Category and a CategoryDraft and returns an UpdateAction<Category> as a result in an Optional.
static java.util.Optional<io.sphere.sdk.commands.UpdateAction<io.sphere.sdk.categories.Category>>	buildSetMetaKeywordsUpdateAction(io.sphere.sdk.categories.Category oldCategory, io.sphere.sdk.categories.CategoryDraft newCategory) Compares the LocalizedString meta keywords of a Category and a CategoryDraft and returns an UpdateAction<Category> as a result in an Optional.
static java.util.Optional<io.sphere.sdk.commands.UpdateAction<io.sphere.sdk.categories.Category>>	buildSetMetaTitleUpdateAction(io.sphere.sdk.categories.Category oldCategory, io.sphere.sdk.categories.CategoryDraft newCategory) Compares the LocalizedString meta title of a Category and a CategoryDraft and returns an UpdateAction<Category> as a result in an Optional.

Methods inherited from class java.lang.Object

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

Method Detail

buildChangeNameUpdateAction

@Nonnull
public static java.util.Optional<io.sphere.sdk.commands.UpdateAction<io.sphere.sdk.categories.Category>> buildChangeNameUpdateAction(@Nonnull
                                                                                                                                              io.sphere.sdk.categories.Category oldCategory,
                                                                                                                                              @Nonnull
                                                                                                                                              io.sphere.sdk.categories.CategoryDraft newCategory)

Compares the LocalizedString names of a Category and a CategoryDraft and returns an UpdateAction<Category> as a result in an Optional. If both the Category and the CategoryDraft have the same name, then no update action is needed and hence an empty Optional is returned.

Parameters:

oldCategory - the category which should be updated.

newCategory - the category draft where we get the new name.

Returns:

A filled optional with the update action or an empty optional if the names are identical.

buildChangeSlugUpdateAction

@Nonnull
public static java.util.Optional<io.sphere.sdk.commands.UpdateAction<io.sphere.sdk.categories.Category>> buildChangeSlugUpdateAction(@Nonnull
                                                                                                                                              io.sphere.sdk.categories.Category oldCategory,
                                                                                                                                              @Nonnull
                                                                                                                                              io.sphere.sdk.categories.CategoryDraft newCategory)

Compares the LocalizedString slugs of a Category and a CategoryDraft and returns an UpdateAction<Category> as a result in an Optional. If both the Category and the CategoryDraft have the same slug, then no update action is needed and hence an empty Optional is returned.

Parameters:

oldCategory - the category which should be updated.

newCategory - the category draft where we get the new slug.

Returns:

A filled optional with the update action or an empty optional if the slugs are identical.

buildSetDescriptionUpdateAction

@Nonnull
public static java.util.Optional<io.sphere.sdk.commands.UpdateAction<io.sphere.sdk.categories.Category>> buildSetDescriptionUpdateAction(@Nonnull
                                                                                                                                                  io.sphere.sdk.categories.Category oldCategory,
                                                                                                                                                  @Nonnull
                                                                                                                                                  io.sphere.sdk.categories.CategoryDraft newCategory)

Compares the LocalizedString descriptions of a Category and a CategoryDraft and returns an UpdateAction<Category> as a result in an Optional. If both the Category and the CategoryDraft have the same description, then no update action is needed and hence an empty Optional is returned.

Parameters:

oldCategory - the category which should be updated.

newCategory - the category draft where we get the new description.

Returns:

A filled optional with the update action or an empty optional if the descriptions are identical.

buildChangeParentUpdateAction

@Nonnull
public static java.util.Optional<io.sphere.sdk.commands.UpdateAction<io.sphere.sdk.categories.Category>> buildChangeParentUpdateAction(@Nonnull
                                                                                                                                                io.sphere.sdk.categories.Category oldCategory,
                                                                                                                                                @Nonnull
                                                                                                                                                io.sphere.sdk.categories.CategoryDraft newCategory,
                                                                                                                                                @Nonnull
                                                                                                                                                CategorySyncOptions syncOptions)

Compares the parents Reference<Category> of a Category and a CategoryDraft and returns an UpdateAction<Category> as a result in an Optional. If both the Category and the CategoryDraft have the same parents, then no update action is needed and hence an empty Optional is returned.

Note: If the parent Reference<Category> of the new CategoryDraft is null, an empty Optional is returned with no update actions and a custom callback function, if set on the supplied CategorySyncOptions, is called.

Parameters:

oldCategory - the category which should be updated.

newCategory - the category draft where we get the new parent.

syncOptions - the sync syncOptions with which a custom callback function is called in case the parent is null.

Returns:

A filled optional with the update action or an empty optional if the parent references are identical.

buildChangeOrderHintUpdateAction

@Nonnull
public static java.util.Optional<io.sphere.sdk.commands.UpdateAction<io.sphere.sdk.categories.Category>> buildChangeOrderHintUpdateAction(@Nonnull
                                                                                                                                                   io.sphere.sdk.categories.Category oldCategory,
                                                                                                                                                   @Nonnull
                                                                                                                                                   io.sphere.sdk.categories.CategoryDraft newCategory,
                                                                                                                                                   @Nonnull
                                                                                                                                                   CategorySyncOptions syncOptions)

Compares the orderHint values of a Category and a CategoryDraft and returns an UpdateAction<Category> as a result in an Optional. If both the Category and the CategoryDraft have the same orderHint, then no update action is needed and hence an empty Optional is returned.

Note: If the orderHint of the new CategoryDraft is null, an empty Optional is returned with no update actions and a custom callback function, if set on the supplied CategorySyncOptions, is called.

Parameters:

oldCategory - the category which should be updated.

newCategory - the category draft where we get the new orderHint.

syncOptions - the sync syncOptions with which a custom callback function is called in case the orderHint is null.

Returns:

A filled optional with the update action or an empty optional if the orderHint values are identical.

buildSetMetaTitleUpdateAction

@Nonnull
public static java.util.Optional<io.sphere.sdk.commands.UpdateAction<io.sphere.sdk.categories.Category>> buildSetMetaTitleUpdateAction(@Nonnull
                                                                                                                                                io.sphere.sdk.categories.Category oldCategory,
                                                                                                                                                @Nonnull
                                                                                                                                                io.sphere.sdk.categories.CategoryDraft newCategory)

Compares the LocalizedString meta title of a Category and a CategoryDraft and returns an UpdateAction<Category> as a result in an Optional. If both the Category and the CategoryDraft have the same meta title, then no update action is needed and hence an empty Optional is returned.

Parameters:

oldCategory - the category which should be updated.

newCategory - the category draft where we get the new meta title.

Returns:

A filled optional with the update action or an empty optional if the meta titles values are identical.

buildSetMetaKeywordsUpdateAction

@Nonnull
public static java.util.Optional<io.sphere.sdk.commands.UpdateAction<io.sphere.sdk.categories.Category>> buildSetMetaKeywordsUpdateAction(@Nonnull
                                                                                                                                                   io.sphere.sdk.categories.Category oldCategory,
                                                                                                                                                   @Nonnull
                                                                                                                                                   io.sphere.sdk.categories.CategoryDraft newCategory)

Compares the LocalizedString meta keywords of a Category and a CategoryDraft and returns an UpdateAction<Category> as a result in an Optional. If both the Category and the CategoryDraft have the same meta keywords, then no update action is needed and hence an empty Optional is returned.

Parameters:

oldCategory - the category which should be updated.

newCategory - the category draft where we get the new meta keywords.

Returns:

A filled optional with the update action or an empty optional if the meta keywords values are identical.

buildSetMetaDescriptionUpdateAction

@Nonnull
public static java.util.Optional<io.sphere.sdk.commands.UpdateAction<io.sphere.sdk.categories.Category>> buildSetMetaDescriptionUpdateAction(@Nonnull
                                                                                                                                                      io.sphere.sdk.categories.Category oldCategory,
                                                                                                                                                      @Nonnull
                                                                                                                                                      io.sphere.sdk.categories.CategoryDraft newCategory)

Compares the LocalizedString meta description of a Category and a CategoryDraft and returns an UpdateAction<Category> as a result in an Optional. If both the Category and the CategoryDraft have the same meta description, then no update action is needed and hence an empty Optional is returned.

Parameters:

oldCategory - the category which should be updated.

newCategory - the category draft where we get the new meta description.

Returns:

A filled optional with the update action or an empty optional if the meta description values are identical.

buildSetExternalIdUpdateAction

@Nonnull
public static java.util.Optional<io.sphere.sdk.commands.UpdateAction<io.sphere.sdk.categories.Category>> buildSetExternalIdUpdateAction(@Nonnull
                                                                                                                                                 io.sphere.sdk.categories.Category oldCategory,
                                                                                                                                                 @Nonnull
                                                                                                                                                 io.sphere.sdk.categories.CategoryDraft newCategory)

Compares the externalId values of a Category and a CategoryDraft and returns an UpdateAction<Category> as a result in an Optional. If both the Category and the CategoryDraft have the same externalId, then no update action is needed and hence an empty Optional is returned.

Parameters:

oldCategory - the category which should be updated.

newCategory - the category draft where we get the new externalId.

Returns:

A filled optional with the update action or an empty optional if the externalId values are identical.

buildAssetsUpdateActions

@Nonnull
public static java.util.List<io.sphere.sdk.commands.UpdateAction<io.sphere.sdk.categories.Category>> buildAssetsUpdateActions(@Nonnull
                                                                                                                                       io.sphere.sdk.categories.Category oldCategory,
                                                                                                                                       @Nonnull
                                                                                                                                       io.sphere.sdk.categories.CategoryDraft newCategory,
                                                                                                                                       @Nonnull
                                                                                                                                       CategorySyncOptions syncOptions)

Compares the assets of a Category and a CategoryDraft and returns a list of UpdateAction<Category> as a result. If both the Category and the CategoryDraft have the identical assets, then no update action is needed and hence an empty List is returned. In case, the new category draft has a list of assets in which a duplicate key exists, the error callback is triggered and an empty list is returned.

Parameters:

oldCategory - the category which should be updated.

newCategory - the category draft where we get the new externalId.

syncOptions - the sync options with which a custom callback function is called in case errors exists while building assets custom field/type actions.

Returns:

A list with the update actions or an empty list if the assets are identical.