com.adobe.cq.commerce.api.promotion.PromotionInfo Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of uber-jar Show documentation
There is a newer version: 6.5.21
/*************************************************************************
 *
 * ADOBE CONFIDENTIAL
 * __________________
 *
 *  Copyright 2012 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.adobe.cq.commerce.api.promotion;

import aQute.bnd.annotation.ProviderType;
import com.adobe.cq.commerce.api.PriceInfo;

/**
 * A POJO which provides information about an applied promotion (including its status and
 * any applied discount).
 *
 * @since 5.6
 */
@ProviderType
public class PromotionInfo {

    /**
     * Status of an applied promotion in the context of a user's cart or order. An applied promotion
     * is either:
     * 
     *     NOT_APPLICABLE: no conditions are currently met
     *     POTENTIAL: some, but not all, conditions are currently met
     *     FIRED: all conditions are met
     * 
     */
    public enum PromotionStatus {
        POTENTIAL, FIRED, NOT_APPLICABLE
    }

    private String path;
    private String title;
    private PromotionStatus status;
    private String description;
    private String message;
    private Integer cartEntryIndex;

    /**
     * Instantiate a new PromotionInfo.
     * @param path The path of the promotion if represented in the repository.  Otherwise, an ID uniquely
     *             identifying the promotion.
     * @param title An author-oriented title.
     * @param status See {@link PromotionStatus}.
     * @param description An author-oriented description of the promotion (and its current status).
     * @param message A shopper-oriented message regarding the current status of the promotion.
     * @param cartEntryIndex The index of the cart entry this promotion applies to, or null
     *                       for order-specific promotions.
     */
    public PromotionInfo(String path, String title, PromotionStatus status, String description, String message, Integer cartEntryIndex) {
        this.path = path;
        this.title = title;
        this.status = status;
        this.message = message;
        this.description = description;
        this.cartEntryIndex = cartEntryIndex;
    }

    /**
     * Get the path or identifier.
     */
    public String getPath() {
        return path;
    }

    /**
     * An author-oriented title.
     */
    public String getTitle() {
        return title;
    }

    /**
     * Get the status.
     */
    public PromotionStatus getStatus() {
        return status;
    }

    /**
     * An author-oriented description of the current status of the promotion.
     */
    public String getDescription() {
        return description;
    }

    /**
     * A shopper-oriented message regarding the current status of the promotion.
     */
    public String getMessage() {
        return message;
    }

    /**
     * Get a cart entry's index in case the promotion is related to a specific cart line item, e.g. discount
     * for seasonal products.
     * For order-level promotions, this method returns null.
     */
    public Integer getCartEntryIndex() {
        return cartEntryIndex;
    }


    /*
     * ==================================================================================================
     * Deprecated methods.  For backwards-compatibility only.
     * ==================================================================================================
     */

    /**
     * @deprecated since 6.0; use {@link PromotionInfo(String, String, PromotionStatus, String, String, Integer)}
     * instead
     */
    @Deprecated
    public PromotionInfo(String path, String title, PromotionStatus status, String message) {
        this.path = path;
        this.title = title;
        this.status = status;
        this.message = message;

        this.description = null;
        this.cartEntryIndex = null;
    }

}