CreateRecurringPaymentsProfile.java

/*
 * Copyright (C) 2010 Pete Reisinger <p.reisinger@gmail.com>.
 * 
 * This program is free software: you can redistribute it and/or modify it under the terms of the
 * GNU General Public License as published by the Free Software Foundation, either version 3 of the
 * License, or (at your option) any later version.
 * 
 * This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without
 * even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
 * General Public License for more details.
 * 
 * You should have received a copy of the GNU General Public License along with this program. If
 * not, see <http://www.gnu.org/licenses/>.
 */

package paypalnvp.request;

import paypalnvp.fields.*;

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

/**
 * Create a recurring payments profile.
 * <p/>
 * You must invoke the CreateRecurringPaymentsProfile API operation for each profile you want to
 * create. The API operation creates a profile and an associated billing agreement.
 * <p/>
 * Note: There is a one-to-one correspondence between billing agreements and recurring payments
 * profiles. To associate a a recurring payments profile with its billing agreement, the description
 * in the recurring payments profile must match the description of a billing agreement. Use
 * SetExpressCheckout to initiate creation of a billing agreement.
 *
 * @author Pete Reisinger
 *         <p.reisinger@gmail.com>
 *         .
 */
@SuppressWarnings("serial")
public final class CreateRecurringPaymentsProfile implements Request {

    /**
     * Method value of this request
     */
    private static final String METHOD_NAME = "CreateRecurringPaymentsProfile";

    /**
     * map that holds name value pair request values
     */
    private final Map<String, String> nvpRequest;

    /**
     * map that holds name value pair response values
     */
    private Map<String, String> nvpResponse;

    private CreateRecurringPaymentsProfile() {

        nvpResponse = new HashMap<String, String>();
        nvpRequest = new HashMap<String, String>();

        nvpRequest.put("METHOD", METHOD_NAME);
    }

    /**
     * Token is appended to the return or cancel url set in SetExpressCheckout.
     *
     * @param token   A timestamped token, the value of which was returned in the response to the first
     *                call to SetExpressCheckout. You can also use the token returned in the
     *                SetCustomerBillingAgreement response. Either this token or a credit card number is
     *                required. If you include both token and credit card number, the token is used and credit
     *                card number is ignored. Call CreateRecurringPaymentsProfile once for each billing
     *                agreement included in SetExpressCheckout request and use the same token for each call.
     *                Each CreateRecurringPaymentsProfile request creates a single recurring payments profile.
     *                Note: Tokens expire after approximately 3 hours.
     * @param details
     * @throws IllegalArgumentException
     */
    public CreateRecurringPaymentsProfile(String token, ScheduleDetails details)
            throws IllegalArgumentException {

        this();

        if (token.length() != 20) {
            throw new IllegalArgumentException("Invalid token argument");
        }

        nvpRequest.put("TOKEN", token);
        nvpRequest.putAll(new HashMap<String, String>(details.getNVPRequest()));
    }

    /**
     * @param card
     */
    public CreateRecurringPaymentsProfile(CreditCard card) {

        this();

        nvpRequest.putAll(new HashMap<String, String>(card.getNVPRequest()));
    }

    /**
     * @param details
     */
    public void setRecurringPaymentsProfileDetails(RecurringPaymentsProfileDetails details) {

        nvpRequest.putAll(new HashMap<String, String>(details.getNVPRequest()));
    }

    /**
     * @param details
     */
    public void setBillingPeriodDetails(BillingPeriodDetails details) {
        nvpRequest.putAll(new HashMap<String, String>(details.getNVPRequest()));
    }

    /**
     * @param details
     */
    public void setActivationDetails(ActivationDetails details) {
        nvpRequest.putAll(new HashMap<String, String>(details.getNVPRequest()));
    }

    /**
     * @param address
     */
    public void setShipToAddress(ShipToAddress address) {
        nvpRequest.putAll(new HashMap<String, String>(address.getNVPRequest()));
    }

    /**
     * @param payer
     */
    public void setPayerInformation(PayerInformation payer) {
        nvpRequest.putAll(new HashMap<String, String>(payer.getNVPRequest()));
    }

    /**
     * @param name
     */
    public void setPayerName(PayerName name) {
        nvpRequest.putAll(new HashMap<String, String>(name.getNVPRequest()));
    }

    /**
     * @param address
     */
    public void setAddress(Address address) {
        nvpRequest.putAll(new HashMap<String, String>(address.getNVPRequest()));
    }

    public Map<String, String> getNVPRequest() {
        return new HashMap<String, String>(nvpRequest);
    }

    public Map<String, String> getNVPResponse() {
        return new HashMap<String, String>(nvpResponse);
    }

    public void setNVPResponse(Map<String, String> nvpResponse) {
        this.nvpResponse = new HashMap<String, String>(nvpResponse);
    }

    @Override
    public String toString() {

        StringBuffer str = new StringBuffer("instance of CreateRecurringPaymentsProfile");
        str.append("class with the vlues: nvpRequest - ");
        str.append(nvpRequest.toString());
        str.append("; nvpResponse - ");
        str.append(nvpResponse.toString());

        return str.toString();
    }
}