Class SubscriptionTermModel

  • All Implemented Interfaces:
    java.io.Serializable

    public class SubscriptionTermModel
    extends ItemModel
    Generated model class for type SubscriptionTerm first defined at extension subscriptionservices.
    See Also:
    Serialized Form
    • Field Detail

      • _TYPECODE

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

        public static final java.lang.String ID
        Generated constant - Attribute key of SubscriptionTerm.id attribute defined at extension subscriptionservices.
        See Also:
        Constant Field Values
      • NAME

        public static final java.lang.String NAME
        Generated constant - Attribute key of SubscriptionTerm.name attribute defined at extension subscriptionservices.
        See Also:
        Constant Field Values
      • TERMOFSERVICENUMBER

        public static final java.lang.String TERMOFSERVICENUMBER
        Generated constant - Attribute key of SubscriptionTerm.termOfServiceNumber attribute defined at extension subscriptionservices.
        See Also:
        Constant Field Values
      • CANCELLABLE

        public static final java.lang.String CANCELLABLE
        Generated constant - Attribute key of SubscriptionTerm.cancellable attribute defined at extension subscriptionservices.
        See Also:
        Constant Field Values
      • TERMOFSERVICERENEWAL

        public static final java.lang.String TERMOFSERVICERENEWAL
        Generated constant - Attribute key of SubscriptionTerm.termOfServiceRenewal attribute defined at extension subscriptionservices.
        See Also:
        Constant Field Values
      • TERMOFSERVICEFREQUENCY

        public static final java.lang.String TERMOFSERVICEFREQUENCY
        Generated constant - Attribute key of SubscriptionTerm.termOfServiceFrequency attribute defined at extension subscriptionservices.
        See Also:
        Constant Field Values
      • BILLINGPLAN

        public static final java.lang.String BILLINGPLAN
        Generated constant - Attribute key of SubscriptionTerm.billingPlan attribute defined at extension subscriptionservices.
        See Also:
        Constant Field Values
      • SUBSCRIPTIONPRODUCTS

        public static final java.lang.String SUBSCRIPTIONPRODUCTS
        Generated constant - Attribute key of SubscriptionTerm.subscriptionProducts attribute defined at extension subscriptionservices.
        See Also:
        Constant Field Values
    • Constructor Detail

      • SubscriptionTermModel

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

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

        @Deprecated(since="4.1.1",
                    forRemoval=true)
        public SubscriptionTermModel​(java.lang.String _id)
        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:
        _id - initial attribute declared by type SubscriptionTerm at extension subscriptionservices
      • SubscriptionTermModel

        @Deprecated(since="4.1.1",
                    forRemoval=true)
        public SubscriptionTermModel​(java.lang.String _id,
                                     ItemModel _owner)
        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:
        _id - initial attribute declared by type SubscriptionTerm at extension subscriptionservices
        _owner - initial attribute declared by type Item at extension core
    • Method Detail

      • getBillingPlan

        @Accessor(qualifier="billingPlan",
                  type=GETTER)
        public BillingPlanModel getBillingPlan()
        Generated method - Getter of the SubscriptionTerm.billingPlan attribute defined at extension subscriptionservices.
        Returns:
        the billingPlan - Billing Plan
      • getCancellable

        @Accessor(qualifier="cancellable",
                  type=GETTER)
        public java.lang.Boolean getCancellable()
        Generated method - Getter of the SubscriptionTerm.cancellable attribute defined at extension subscriptionservices.
        Returns:
        the cancellable - Cancellable
      • getId

        @Accessor(qualifier="id",
                  type=GETTER)
        public java.lang.String getId()
        Generated method - Getter of the SubscriptionTerm.id attribute defined at extension subscriptionservices.
        Returns:
        the id - Identifier
      • getName

        @Accessor(qualifier="name",
                  type=GETTER)
        public java.lang.String getName()
        Generated method - Getter of the SubscriptionTerm.name attribute defined at extension subscriptionservices.
        Returns:
        the name - Name
      • getName

        @Accessor(qualifier="name",
                  type=GETTER)
        public java.lang.String getName​(java.util.Locale loc)
        Generated method - Getter of the SubscriptionTerm.name attribute defined at extension subscriptionservices.
        Parameters:
        loc - the value localization key
        Returns:
        the name - Name
        Throws:
        java.lang.IllegalArgumentException - if localization key cannot be mapped to data language
      • getSubscriptionProducts

        @Accessor(qualifier="subscriptionProducts",
                  type=GETTER)
        public java.util.Collection<ProductModel> getSubscriptionProducts()
        Generated method - Getter of the SubscriptionTerm.subscriptionProducts attribute defined at extension subscriptionservices. Consider using FlexibleSearchService::searchRelation for pagination support of large result sets.
        Returns:
        the subscriptionProducts
      • getTermOfServiceFrequency

        @Accessor(qualifier="termOfServiceFrequency",
                  type=GETTER)
        public TermOfServiceFrequency getTermOfServiceFrequency()
        Generated method - Getter of the SubscriptionTerm.termOfServiceFrequency attribute defined at extension subscriptionservices.
        Returns:
        the termOfServiceFrequency - Term of Service Frequency
      • getTermOfServiceNumber

        @Accessor(qualifier="termOfServiceNumber",
                  type=GETTER)
        public java.lang.Integer getTermOfServiceNumber()
        Generated method - Getter of the SubscriptionTerm.termOfServiceNumber attribute defined at extension subscriptionservices.
        Returns:
        the termOfServiceNumber - Term of Service Number
      • getTermOfServiceRenewal

        @Accessor(qualifier="termOfServiceRenewal",
                  type=GETTER)
        public TermOfServiceRenewal getTermOfServiceRenewal()
        Generated method - Getter of the SubscriptionTerm.termOfServiceRenewal attribute defined at extension subscriptionservices.
        Returns:
        the termOfServiceRenewal - Term of Service Renewal
      • setBillingPlan

        @Accessor(qualifier="billingPlan",
                  type=SETTER)
        public void setBillingPlan​(BillingPlanModel value)
        Generated method - Setter of SubscriptionTerm.billingPlan attribute defined at extension subscriptionservices.
        Parameters:
        value - the billingPlan - Billing Plan
      • setCancellable

        @Accessor(qualifier="cancellable",
                  type=SETTER)
        public void setCancellable​(java.lang.Boolean value)
        Generated method - Setter of SubscriptionTerm.cancellable attribute defined at extension subscriptionservices.
        Parameters:
        value - the cancellable - Cancellable
      • setId

        @Accessor(qualifier="id",
                  type=SETTER)
        public void setId​(java.lang.String value)
        Generated method - Initial setter of SubscriptionTerm.id attribute defined at extension subscriptionservices. Can only be used at creation of model - before first save.
        Parameters:
        value - the id - Identifier
      • setName

        @Accessor(qualifier="name",
                  type=SETTER)
        public void setName​(java.lang.String value)
        Generated method - Setter of SubscriptionTerm.name attribute defined at extension subscriptionservices.
        Parameters:
        value - the name - Name
      • setName

        @Accessor(qualifier="name",
                  type=SETTER)
        public void setName​(java.lang.String value,
                            java.util.Locale loc)
        Generated method - Setter of SubscriptionTerm.name attribute defined at extension subscriptionservices.
        Parameters:
        value - the name - Name
        loc - the value localization key
        Throws:
        java.lang.IllegalArgumentException - if localization key cannot be mapped to data language
      • setSubscriptionProducts

        @Accessor(qualifier="subscriptionProducts",
                  type=SETTER)
        public void setSubscriptionProducts​(java.util.Collection<ProductModel> value)
        Generated method - Setter of SubscriptionTerm.subscriptionProducts attribute defined at extension subscriptionservices.
        Parameters:
        value - the subscriptionProducts
      • setTermOfServiceFrequency

        @Accessor(qualifier="termOfServiceFrequency",
                  type=SETTER)
        public void setTermOfServiceFrequency​(TermOfServiceFrequency value)
        Generated method - Setter of SubscriptionTerm.termOfServiceFrequency attribute defined at extension subscriptionservices.
        Parameters:
        value - the termOfServiceFrequency - Term of Service Frequency
      • setTermOfServiceNumber

        @Accessor(qualifier="termOfServiceNumber",
                  type=SETTER)
        public void setTermOfServiceNumber​(java.lang.Integer value)
        Generated method - Setter of SubscriptionTerm.termOfServiceNumber attribute defined at extension subscriptionservices.
        Parameters:
        value - the termOfServiceNumber - Term of Service Number
      • setTermOfServiceRenewal

        @Accessor(qualifier="termOfServiceRenewal",
                  type=SETTER)
        public void setTermOfServiceRenewal​(TermOfServiceRenewal value)
        Generated method - Setter of SubscriptionTerm.termOfServiceRenewal attribute defined at extension subscriptionservices.
        Parameters:
        value - the termOfServiceRenewal - Term of Service Renewal