Request.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 java.io.Serializable;
import java.util.Map;

/**
 * @author Pete Reisinger <p.reisinger@gmail.com>.
 */
public interface Request extends Serializable {

    /**
     * Creates and returns part of the nvp (name value pair) request containing
     * request values
     *
     * @return part of the nvp request as a Map
     */
    Map<String, String> getNVPRequest();

    /**
     * Return response from paypal. If response is not set/received returns
     * empty Map.
     *
     * @return response from paypal as a Map
     */
    Map<String, String> getNVPResponse();

    /**
     * Setter for nvp (name value pair) response
     *
     * @param nvpResponse
     */
    void setNVPResponse(Map<String, String> nvpResponse);
}