Class MultiCodeCouponModel

  • All Implemented Interfaces:
    java.io.Serializable

    public class MultiCodeCouponModel
    extends AbstractCouponModel
    Generated model class for type MultiCodeCoupon first defined at extension couponservices.

    A MultiCodeCoupon uses generated coupon codes for coupon redemption. The (inherited) couponId attribute functions as a prefix for the generated coupon codes.

    See Also:
    Serialized Form
    • Field Detail

      • _TYPECODE

        public static final java.lang.String _TYPECODE
        Generated model type code constant.
        See Also:
        Constant Field Values
      • CODEGENERATIONCONFIGURATION

        public static final java.lang.String CODEGENERATIONCONFIGURATION
        Generated constant - Attribute key of MultiCodeCoupon.codeGenerationConfiguration attribute defined at extension couponservices.
        See Also:
        Constant Field Values
      • GENERATEDCODES

        public static final java.lang.String GENERATEDCODES
        Generated constant - Attribute key of MultiCodeCoupon.generatedCodes attribute defined at extension couponservices.
        See Also:
        Constant Field Values
      • ALPHABET

        public static final java.lang.String ALPHABET
        Generated constant - Attribute key of MultiCodeCoupon.alphabet attribute defined at extension couponservices.
        See Also:
        Constant Field Values
      • SIGNATURE

        public static final java.lang.String SIGNATURE
        Generated constant - Attribute key of MultiCodeCoupon.signature attribute defined at extension couponservices.
        See Also:
        Constant Field Values
      • COUPONCODENUMBER

        public static final java.lang.String COUPONCODENUMBER
        Generated constant - Attribute key of MultiCodeCoupon.couponCodeNumber attribute defined at extension couponservices.
        See Also:
        Constant Field Values
    • Constructor Detail

      • MultiCodeCouponModel

        public MultiCodeCouponModel()
        Generated constructor - Default constructor for generic creation.
      • MultiCodeCouponModel

        public MultiCodeCouponModel​(ItemModelContext ctx)
        Generated constructor - Default constructor for creation with existing context
        Parameters:
        ctx - the model context to be injected, must not be null
      • MultiCodeCouponModel

        @Deprecated(since="4.1.1",
                    forRemoval=true)
        public MultiCodeCouponModel​(CodeGenerationConfigurationModel _codeGenerationConfiguration,
                                    java.lang.String _couponId)
        Deprecated, for removal: This API element is subject to removal in a future version.
        since 4.1.1 Please use the default constructor without parameters
        Generated constructor - Constructor with all mandatory attributes.
        Parameters:
        _codeGenerationConfiguration - initial attribute declared by type MultiCodeCoupon at extension couponservices
        _couponId - initial attribute declared by type AbstractCoupon at extension couponservices
      • MultiCodeCouponModel

        @Deprecated(since="4.1.1",
                    forRemoval=true)
        public MultiCodeCouponModel​(java.lang.String _alphabet,
                                    CodeGenerationConfigurationModel _codeGenerationConfiguration,
                                    java.lang.String _couponId,
                                    ItemModel _owner,
                                    java.lang.String _signature)
        Deprecated, for removal: This API element is subject to removal in a future version.
        since 4.1.1 Please use the default constructor without parameters
        Generated constructor - for all mandatory and initial attributes.
        Parameters:
        _alphabet - initial attribute declared by type MultiCodeCoupon at extension couponservices
        _codeGenerationConfiguration - initial attribute declared by type MultiCodeCoupon at extension couponservices
        _couponId - initial attribute declared by type AbstractCoupon at extension couponservices
        _owner - initial attribute declared by type Item at extension core
        _signature - initial attribute declared by type MultiCodeCoupon at extension couponservices
    • Method Detail

      • getAlphabet

        @Accessor(qualifier="alphabet",
                  type=GETTER)
        public java.lang.String getAlphabet()
        Generated method - Getter of the MultiCodeCoupon.alphabet attribute defined at extension couponservices.
        Returns:
        the alphabet - used for coupon code generation. The alphabet is a 16 character long distinct set of characters.
      • getCodeGenerationConfiguration

        @Accessor(qualifier="codeGenerationConfiguration",
                  type=GETTER)
        public CodeGenerationConfigurationModel getCodeGenerationConfiguration()
        Generated method - Getter of the MultiCodeCoupon.codeGenerationConfiguration attribute defined at extension couponservices.
        Returns:
        the codeGenerationConfiguration
      • getCouponCodeNumber

        @Accessor(qualifier="couponCodeNumber",
                  type=GETTER)
        public java.lang.Long getCouponCodeNumber()
        Generated method - Getter of the MultiCodeCoupon.couponCodeNumber attribute defined at extension couponservices.
        Returns:
        the couponCodeNumber - used for coupon code generation. The coupon code number functions as a seed for coupon codes.
      • getGeneratedCodes

        @Accessor(qualifier="generatedCodes",
                  type=GETTER)
        public java.util.Collection<MediaModel> getGeneratedCodes()
        Generated method - Getter of the MultiCodeCoupon.generatedCodes attribute defined at extension couponservices. Consider using FlexibleSearchService::searchRelation for pagination support of large result sets.
        Returns:
        the generatedCodes
      • getSignature

        @Accessor(qualifier="signature",
                  type=GETTER)
        public java.lang.String getSignature()
        Generated method - Getter of the MultiCodeCoupon.signature attribute defined at extension couponservices.
        Returns:
        the signature - used for coupon code generation. The signature is a base64 encoded signature used for the ciphertext part of the coupon code.
      • setAlphabet

        @Accessor(qualifier="alphabet",
                  type=SETTER)
        public void setAlphabet​(java.lang.String value)
        Generated method - Initial setter of MultiCodeCoupon.alphabet attribute defined at extension couponservices. Can only be used at creation of model - before first save.
        Parameters:
        value - the alphabet - used for coupon code generation. The alphabet is a 16 character long distinct set of characters.
      • setCodeGenerationConfiguration

        @Accessor(qualifier="codeGenerationConfiguration",
                  type=SETTER)
        public void setCodeGenerationConfiguration​(CodeGenerationConfigurationModel value)
        Generated method - Setter of MultiCodeCoupon.codeGenerationConfiguration attribute defined at extension couponservices.
        Parameters:
        value - the codeGenerationConfiguration
      • setCouponCodeNumber

        @Accessor(qualifier="couponCodeNumber",
                  type=SETTER)
        public void setCouponCodeNumber​(java.lang.Long value)
        Generated method - Setter of MultiCodeCoupon.couponCodeNumber attribute defined at extension couponservices.
        Parameters:
        value - the couponCodeNumber - used for coupon code generation. The coupon code number functions as a seed for coupon codes.
      • setGeneratedCodes

        @Accessor(qualifier="generatedCodes",
                  type=SETTER)
        public void setGeneratedCodes​(java.util.Collection<MediaModel> value)
        Generated method - Setter of MultiCodeCoupon.generatedCodes attribute defined at extension couponservices.
        Parameters:
        value - the generatedCodes
      • setSignature

        @Accessor(qualifier="signature",
                  type=SETTER)
        public void setSignature​(java.lang.String value)
        Generated method - Initial setter of MultiCodeCoupon.signature attribute defined at extension couponservices. Can only be used at creation of model - before first save.
        Parameters:
        value - the signature - used for coupon code generation. The signature is a base64 encoded signature used for the ciphertext part of the coupon code.