Package com.broadleafcommerce.promotion.campaign.domain

Class CampaignCodeAuditDetail

  • All Implemented Interfaces:
    com.broadleafcommerce.data.tracking.core.ContextStateAware, Serializable
    public class CampaignCodeAuditDetail
extends Object
implements Serializable, com.broadleafcommerce.data.tracking.core.ContextStateAware

    Captures audit relevant data for a particular CampaignCode.

    Utilized when it is necessary to determine if a particular code can still be used by checking the number of records against CampaignCode.getMaxUses().

    Author:
    Samarth Dhruva (samarthd)
    See Also:
    Serialized Form

    • Constructor Detail

      • CampaignCodeAuditDetail

        public CampaignCodeAuditDetail()

    • Method Detail

      • getId

        public String getId()
        The context ID of the campaign code audit detail.
        Returns:
        the context ID of the campaign code audit detail

      • getCampaignCode

        public String getCampaignCode()
        The campaign code string that this audit information is for.
        Returns:
        The campaign code string that this audit information is for.

      • getCampaignTrackingId

        public String getCampaignTrackingId()
        The tracking ID of the campaign this audit is for.
        Returns:
        the tracking ID of the campaign this audit is for

      • getUser

        public UserTarget getUser()
        The identifying info of the user that used the campaign code.
        Returns:
        The identifying info of the user that used the the campaign code.

      • getDateApplied

        public Instant getDateApplied()
        The date and time when the related campaign code was applied.
        Returns:
        the date and time when the related campaign code was applied

      • getContextState

        public com.broadleafcommerce.data.tracking.core.filtering.business.domain.ContextState getContextState()
        A subset of Tracking information to expose the context state for this object.
        Specified by:
        getContextState in interface com.broadleafcommerce.data.tracking.core.ContextStateAware
        Returns:
        a subset of Tracking information to expose the context state for this object

      • setId

        public void setId​(String id)
        The context ID of the campaign code audit detail.
        Parameters:
        id - the context ID of the campaign code audit detail

      • setCampaignCode

        public void setCampaignCode​(String campaignCode)
        The campaign code string that this audit information is for.
        Parameters:
        campaignCode - The campaign code string that this audit information is for.

      • setCampaignTrackingId

        public void setCampaignTrackingId​(String campaignTrackingId)
        The tracking ID of the campaign this audit is for.
        Parameters:
        campaignTrackingId - the tracking ID of the campaign this audit is for

      • setUser

        public void setUser​(UserTarget user)
        The identifying info of the user that used the campaign code.
        Parameters:
        user - The identifying info of the user that used the campaign code.

      • setDateApplied

        public void setDateApplied​(Instant dateApplied)
        The date and time when the related campaign code was applied.
        Parameters:
        dateApplied - the date and time when the related campaign code was applied

      • setContextState

        public void setContextState​(com.broadleafcommerce.data.tracking.core.filtering.business.domain.ContextState contextState)
        A subset of Tracking information to expose the context state for this object.
        Specified by:
        setContextState in interface com.broadleafcommerce.data.tracking.core.ContextStateAware
        Parameters:
        contextState - a subset of Tracking information to expose the context state for this object

      • canEqual

        protected boolean canEqual​(Object other)

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class Object