com.day.cq.dam.api.s7dam.set.SwatchSet Maven / Gradle / Ivy

/*************************************************************************
 *
 * ADOBE CONFIDENTIAL
 * ___________________
 *
 *  Copyright 2013 Adobe Systems Incorporated
 *  All Rights Reserved.
 *
 * NOTICE:  All information contained herein is, and remains
 * the property of Adobe Systems Incorporated and its suppliers,
 * if any.  The intellectual and technical concepts contained
 * herein are proprietary to Adobe Systems Incorporated and its
 * suppliers and are protected by trade secret or copyright law.
 * Dissemination of this information or reproduction of this material
 * is strictly forbidden unless prior written permission is obtained
 * from Adobe Systems Incorporated.
 **************************************************************************/

package com.day.cq.dam.api.s7dam.set;

import aQute.bnd.annotation.ProviderType;

import com.day.cq.dam.api.Asset;

/**
 * Represents a Scene7 Swatch Set.
 * This interface has been deperecated. Use {@link MediaSet} instead of this.
 * @deprecated Not for public use - this API will be replaced in a future release
 * 
 */
@ProviderType
@Deprecated
public interface SwatchSet extends ImageSet {
    /**
     * Add an asset and swatch to the swatch set and
     * returns true if successful.
     * 
     * @param asset {@link Asset} instance to be added
     * @param swatch {@link Asset} instance to be added as swatch.
     * @return true if operation is successful.
     *        or false if asset is already contained in the resource.
     * 
     */
    boolean add(Asset asset, Asset swatch);
    
    /**
     * Returns the swatch for an {@link Asset} which is the part of the Swatch Set.
     *
     * @return swatch for an {@link Asset} in swatch set.
     */
    Asset getSwatch(Asset asset);
    
    /**
     * Sets the swatch for an {@link Asset} which is the part of the Swatch Set.
     * 
     * @param asset {@link Asset} for which a swatch is to be set
     * @param swatch {@link Asset} which is to be used as swatch
     */
    void setSwatch(Asset asset, Asset swatch);
}