com.day.cq.dam.stock.integration.StockAssetResultColumn Maven / Gradle / Ivy

/*************************************************************************
 *
 * ADOBE CONFIDENTIAL
 * __________________
 *
 *  Copyright 2018 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.stock.integration;

/**
 * The StockAssetResultColumn enum defines additional, integration specific properties
 * of the SyntheticStockAssetResource that are not part of the original result columns
 * of a StockFile of the Stock Java SDK.
 */

public enum StockAssetResultColumn {

    /**
     * URL of an appropriate rendition for preview purposes in AEM
     */
    AEM_PREVIEW_URL("aem_preview_url"),

    /**
     * Default node name of the imported DAM asset
     */
    AEM_IMPORT_NAME("aem_import_name");

    /**
     * The corresponding value for the StockAssetResultColumn enum.
     */
    private String mValue;

    /**
     * Constructs the StockAssetResultColumn enum with provided string value.
     *
     * @param value the string value of the enum
     */
    StockAssetResultColumn(final String value) {
        this.mValue = value;
    }

    /**
     * Returns the string value of the enum.
     */
    @Override
    public String toString() {
        return this.mValue;
    }
}