io.sphere.sdk.models.Asset Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of commercetools-models Show documentation

There is a newer version: 2.16.0

package io.sphere.sdk.models;

import com.fasterxml.jackson.annotation.JsonProperty;
import com.fasterxml.jackson.databind.annotation.JsonDeserialize;
import io.sphere.sdk.products.ProductVariant;
import io.sphere.sdk.types.Custom;
import io.sphere.sdk.types.CustomFields;
import io.sphere.sdk.types.TypeDraft;

import javax.annotation.Nonnull;
import javax.annotation.Nullable;
import java.util.List;
import java.util.Set;

/**
 * Media assets for product variants.
 *
 * @see ProductVariant#getAssets()
 * @see io.sphere.sdk.products.commands.updateactions.AddAsset
 * @see io.sphere.sdk.products.commands.updateactions.RemoveAsset
 * @see io.sphere.sdk.products.commands.updateactions.ChangeAssetOrder
 * @see io.sphere.sdk.products.commands.updateactions.ChangeAssetName
 * @see io.sphere.sdk.products.commands.updateactions.SetAssetDescription
 * @see io.sphere.sdk.products.commands.updateactions.SetAssetTags
 * @see io.sphere.sdk.products.commands.updateactions.SetAssetCustomType
 * @see io.sphere.sdk.products.commands.updateactions.SetAssetCustomField
 */
@JsonDeserialize(as = AssetImpl.class)
public interface Asset extends Custom , WithKey{

    String getId();

    @Override
    String getKey();

    List getSources();

    LocalizedString getName();

    @Nullable
    LocalizedString getDescription();

    /**
     * Gets the tags belonging to this asset or an empty set.
     *
     * @return tags
     */
    @Nonnull
    Set getTags();

    @Override
    @Nullable
    CustomFields getCustom();

    /**
     * An identifier for this sub-resource which supports {@link CustomFields}.
     * @see TypeDraft#getResourceTypeIds()
     * @see io.sphere.sdk.types.Custom
     * @return ID of this resource type
     */
    static String resourceTypeId() {
        return "asset";
    }
}