org.broadleafcommerce.common.payment.dto.SubscriptionDTO Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of broadleaf-common Show documentation
A collection of classes shared by broadleaf profile, cms, admin, and core.
There is a newer version: 3.1.15-GA
/*
 * #%L
 * BroadleafCommerce Common Libraries
 * %%
 * Copyright (C) 2009 - 2014 Broadleaf Commerce
 * %%
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 * 
 *       http://www.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 * #L%
 */
package org.broadleafcommerce.common.payment.dto;

import java.util.HashMap;
import java.util.Map;

/**
 * @author Chad Harchar (charchar)
 *
 * Many payment solutions allow you to set up subscriptions (recurring payments)
 * with payment transactions.
 *
 * The following DTO represent the usual parameters that you may wish to pass:
 *
 * recurringAmount: the amount that you charge for every recurring payment
 * frequency: the frequency of the recurring payment
 * numberOfInstallments: the number of payments for this subscription
 * startDate: the start date for this subscription
 *
 */
public class SubscriptionDTO {

    protected T parent;

    protected Map additionalFields;
    protected String recurringAmount;
    protected String frequency;
    protected String numberOfInstallments;
    protected String startDate;

    public SubscriptionDTO() {
        this.additionalFields = new HashMap();
    }

    public SubscriptionDTO(T parent) {
        this.additionalFields = new HashMap();
        this.parent = parent;
    }

    public T done() {
        return parent;
    }

    public SubscriptionDTO additionalFields(String key, Object value) {
        additionalFields.put(key, value);
        return this;
    }

    public SubscriptionDTO recurringAmount(String recurringAmount) {
        this.recurringAmount = recurringAmount;
        return this;
    }

    public SubscriptionDTO frequency(String frequency) {
        this.frequency = frequency;
        return this;
    }

    public SubscriptionDTO numberOfInstallments(String numberOfInstallments) {
        this.numberOfInstallments = numberOfInstallments;
        return this;
    }

    public SubscriptionDTO startDate(String startDate) {
        this.startDate = startDate;
        return this;
    }

    public Map getAdditionalFields() {
        return additionalFields;
    }

    public String getRecurringAmount() {
        return recurringAmount;
    }

    public String getFrequency() {
        return frequency;
    }

    public String getNumberOfInstallments() {
        return numberOfInstallments;
    }

    public String getStartDate() {
        return startDate;
    }

    public boolean subscriptionPopulated() {
        return ((getAdditionalFields() != null && !getAdditionalFields().isEmpty()) ||
                getRecurringAmount() != null ||
                getFrequency() != null ||
                getNumberOfInstallments() != null ||
                getStartDate() != null);
    }
}