gehgassi_backend/gehGassi.Domain/Vouchers/VoucherCampaign.cs

using gehGassi.Domain.Base;
using gehGassi.Domain.Common;
using gehGassi.Domain.Localization;
using System;
using System.ComponentModel.DataAnnotations;
using System.ComponentModel.DataAnnotations.Schema;
using NetTopologySuite.Geometries;

namespace gehGassi.Domain.Vouchers
{
    /// <summary>
    /// Repräsentiert eine Gutschein-Kampagne für Kunden
    /// </summary>
    public class VoucherCampaign : SyncEntityLocalizable, IAuditable
    {
        /// <summary>
        /// Id des Kunden
        /// </summary>
        [Required]
        public long CustomerId { get; set; }

        /// <summary>
        /// Titel der Kampagne
        /// </summary>
        [Required]
        [MaxLength(255)]
        public string Title { get; set; }

        /// <summary>
        /// Prefix für die Gutscheine für die Kampagne - muss eindeutig sein
        /// </summary>
        [Required]
        [MaxLength(4)]
		public string Prefix { get; set; }

        /// <summary>
        /// Startdatum der Kampagne
        /// </summary>
        public DateTimeOffset? StartDate { get; set; }

        /// <summary>
        /// Enddatum der Kampagne
        /// </summary>
        public DateTimeOffset? EndDate { get; set; }

        /// <summary>
        /// Typ der Kampagne
        /// </summary>
        [Required]
        public VoucherCampaignType CampaignType { get; set; }

        /// <summary>
        /// Status der Kampagne
        /// </summary>
        [Required]
        public VoucherCampaignStatus Status { get; set; }

        /// <summary>
        /// Anzahl der Gutscheine die erstellt werden sollen.
        /// 0 Wenn unbegrenzt
        /// </summary>
        [Required]
        public int NumberOfVouchers { get; set; }

        /// <summary>
        /// Wie viele Gutscheine wurden bereits verwendet
        /// </summary>
        [Required]
        public int VouchersUsed { get; set; }

        /// <summary>
        /// Wie oft darf ein Gutschein pro User verwendet werden
        /// </summary>
        [Required]
        public int MaxUsagePerUser { get; set; }

        /// <summary>
        /// Gesamt verfügbares Budget
        /// </summary>
        [Required]
        public decimal Budget { get; set; }

        /// <summary>
        /// Aktuell verbrauchtes Budget
        /// </summary>
        [Required]
        public decimal BudgetUsed { get; set; }

        /// <summary>
        /// Wert für einen Gutschein
        /// </summary>
        [Required]
        public decimal VoucherAmmount{ get; set; }

        /// <summary>
        /// Id der Wallet für Transkationen
        /// </summary>
        [Required]
        [MaxLength(255)]
        public string WalletFeeId { get; set; }

        /// <summary>
        /// Id der Wallet mit dem Guthaben
        /// </summary>
        [Required]
        [MaxLength(255)]
        public string WalletCreditId { get; set; }

        #region Payment

        /// <summary>
        /// Id des Carts, wenn im Draft-Modus
        /// </summary>
        public long? CartId { get; set; }

        /// <summary>
        /// Id des Artikels im Cart, wenn im Draft-Modus
        /// </summary>
        public long? CartItemId { get; set; }

        /// <summary>
        /// Id der Bestellung
        /// </summary>
        public long? OrderId { get; set; }

        /// <summary>
        /// Id des Artikels in der Bestellung
        /// </summary>
        public long? OrderItemId { get; set; }

        /// <summary>
        /// Zahlungsart der Bestellung
        /// </summary>
        [Required]
        public PaymentType PaymentType { get; set; }

        /// <summary>
        /// Zahlungsstatus der Bestellung
        /// </summary>
        [Required]
        public PaymentStatus PaymentStatus { get; set; }

        /// <summary>
        /// Zahlungsdatum
        /// </summary>
        public DateTimeOffset? PayedDate { get; set; }

        #endregion

        #region Inhalt

        /// <summary>
        /// Bild - für Kampagne
        /// </summary>
        [MaxLength(500)]
        public string Image { get; set; }

        /// <summary>
        /// Link für Kampagne
        /// </summary>
        [MaxLength(2083)]
        public string Url { get; set; }

        /// <summary>
        /// Name der Kampagne
        /// </summary>
        [Localized]
        [NotMapped]
        public string Name
        {
            get => Get("Name", GetLanguage());
            set => Set("Name", GetLanguage(), value);
        }

        /// <summary>
        /// Name - Inhalt
        /// </summary>
        [Column]
        public string NameLocalized { get; set; }

        /// <summary>
        /// Bild der Kampagne für eine Sprache
        /// </summary>
        [Localized]
        [NotMapped]
        public string ImageLanguage
        {
            get => Get("ImageLanguage", GetLanguage());
            set => Set("ImageLanguage", GetLanguage(), value);
        }

        /// <summary>
        /// Bild der Kampagne für eine Sprache - Dateiname
        /// </summary>
        [Column]
        public string ImageLanguageLocalized { get; set; }

        /// <summary>
        /// Link der Kampagne für eine Sprache
        /// </summary>
        [Localized]
        [NotMapped]
        public string UrlLanguage
        {
            get => Get("UrlLanguage", GetLanguage());
            set => Set("UrlLanguage", GetLanguage(), value);
        }

        /// <summary>
        /// Link des Kampagne für eine Sprache
        /// </summary>
        [Column]
        public string UrlLanguageLocalized { get; set; }

        #endregion

        #region Geo-Einschränkungen

        /// <summary>
        /// Art der Geo-Einschränkung
        /// </summary>
        [Required]
        public GeoMode GeoMode { get; set; }

        /// <summary>
        /// Die Adresse die verwendet werden soll.
        /// Je nach Einstellung in GeoMode werden unterschiedliche Teile verwendet.
        /// None -> Wird ignoriert
        /// Country -> Das Land der Adresse wird verwendet
        /// CountryAndState -> Land und Bundeslande wirde verwendet,
        /// Location --> Lat Lng und Radius in Kombination mit Adresse wird verwendet
        /// </summary>
        public Address Address { get; set; }

        /// <summary>
        /// Geo-Koordinaten
        /// </summary>
        public Point Location { get; set; }

        /// <summary>
        /// Radius für eine Geolocation
        /// </summary>
        public double Radius { get; set; }

        #endregion

        /// <summary>
        /// Datum der Erstellung
        /// </summary>
        public DateTimeOffset Created { get; set; }

        #region IAuditable

        /// <summary>
        /// Gibt den eindeutigen Key für die Entität zurück;
        /// Hier als String gelöst, weil damit auch kombinierte Schlüssel möglich sind.
        /// </summary>
        /// <returns>Eindeutiger Key</returns>
        public string AuditKey()
        {
            return Id.ToString();
        }

        /// <summary>
        /// Gibt den Objektnamen bzw. die Tabelle der Entität zurück
        /// </summary>
        /// <returns>Objektnamen</returns>
        public string AuditTable()
        {
            return "VoucherCampaigns";
        }

        public AuditableOptions Options()
        {
            return AuditableOptions.Create | AuditableOptions.Edit | AuditableOptions.Delete;
        }

        #endregion
    }

    /// <summary>
    /// Repräsentiert eine Gutschein-Kampagne für Kunden für Listen
    /// </summary>
    public class VoucherCampaignWithNames : SyncEntityVw
    {
        /// <summary>
        /// Id des Kunden
        /// </summary>
        public long CustomerId { get; set; }

        /// <summary>
        /// Name des Kunden
        /// </summary>
        public string CustomerName { get; set; }

        /// <summary>
        /// Titel der Kampagne
        /// </summary>
        public string Title { get; set; }

        /// <summary>
        /// Prefix für die Gutscheine für die Kampagne - muss eindeutig sein
        /// </summary>
        public string Prefix { get; set; }

		/// <summary>
		/// Startdatum der Kampagne
		/// </summary>
		public DateTimeOffset? StartDate { get; set; }

        /// <summary>
        /// Enddatum der Kampagne
        /// </summary>
        public DateTimeOffset? EndDate { get; set; }

        /// <summary>
        /// Typ der Kampagne
        /// </summary>
        public VoucherCampaignType CampaignType { get; set; }

        /// <summary>
        /// Status der Kampagne
        /// </summary>
        public VoucherCampaignStatus Status { get; set; }

        /// <summary>
        /// Anzahl der Gutscheine die erstellt werden sollen.
        /// 0 Wenn unbegrenzt
        /// </summary>
        public int NumberOfVouchers { get; set; }

        /// <summary>
        /// Wie viele Gutscheine wurden bereits verwendet
        /// </summary>
        public int VouchersUsed { get; set; }

        /// <summary>
        /// Wie oft darf ein Gutschein pro User verwendet werden
        /// </summary>
        public int MaxUsagePerUser { get; set; }

        /// <summary>
        /// Gesamt verfügbares Budget
        /// </summary>
        public decimal Budget { get; set; }

        /// <summary>
        /// Aktuell verbrauchtes Budget
        /// </summary>
        public decimal BudgetUsed { get; set; }

        /// <summary>
        /// Wert für einen Gutschein
        /// </summary>
        public decimal VoucherAmmount { get; set; }

        #region Payment

        /// <summary>
        /// Zahlungsart der Bestellung
        /// </summary>
        public PaymentType PaymentType { get; set; }

        /// <summary>
        /// Zahlungsstatus der Bestellung
        /// </summary>
        public PaymentStatus PaymentStatus { get; set; }

        /// <summary>
        /// Zahlungsdatum
        /// </summary>
        public DateTimeOffset? PayedDate { get; set; }

        #endregion

        #region Inhalt

        /// <summary>
        /// Bild für die Kampagne - Allgemein
        /// </summary>
        public string Image { get; set; }

        /// <summary>
        /// Link für die Kampagne - allgemein wenn nicht überschrieben
        /// </summary>
        public string Url { get; set; }

        /// <summary>
        /// Name der Kampagne
        /// </summary>
        public string Name { get; set; }

        /// <summary>
        /// Name - Inhalt
        /// </summary>
        [Column]
        public string NameLocalized { get; set; }

        /// <summary>
        /// Bild der Kampagne für eine Sprache
        /// </summary>
        public string ImageLanguage { get; set; }

        /// <summary>
        /// Bild der Kampagne für eine Sprachee - Dateiname
        /// </summary>
        [Column]
        public string ImageLanguageLocalized { get; set; }

        /// <summary>
        /// Link für die Kampagne für eine Sprache
        /// </summary>
        public string UrlLanguage { get; set; }

        /// <summary>
        /// Link der Kampagne für eine Sprache
        /// </summary>
        [Column]
        public string UrlLanguageLocalized { get; set; }

        #endregion

        #region Geo-Einschränkungen

        /// <summary>
        /// Art der Geo-Einschränkung
        /// </summary>
        public GeoMode GeoMode { get; set; }

        /// <summary>
        /// Bundesland / Staat
        /// </summary>
        public string Address_State { get; set; }

        /// <summary>
        /// ISO2 Ländercode
        /// </summary>
        public string Address_CountryCode { get; set; }

        /// <summary>
        /// Geo-Koordinaten
        /// </summary>
        public Point Location { get; set; }

        /// <summary>
        /// Radius für eine Geolocation
        /// </summary>
        public double Radius { get; set; }

        #endregion

        /// <summary>
        /// Datum der Erstellung
        /// </summary>
        public DateTimeOffset Created { get; set; }
    }
}