paypalnvp.fields
Class ScheduleDetails

java.lang.Object
  paypalnvp.fields.ScheduleDetails

All Implemented Interfaces:

java.io.Serializable, RequestFields

public final class ScheduleDetails
extends java.lang.Object
implements RequestFields

Schedule Details Fields

See Also:

Serialized Form

Constructor Summary

ScheduleDetails(java.lang.String description)

Method Summary

java.util.Map<java.lang.String,java.lang.String>	getNVPRequest() Creates and returns part of the nvp (name value pair) request containing request values
void	setAutoBillAmount(boolean autoBill) This field indicates whether you would like PayPal to automatically bill the outstanding balance amount in the next billing cycle.
void	setMaxFailedPayments(int number)
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

ScheduleDetails

public ScheduleDetails(java.lang.String description)
                throws java.lang.IllegalArgumentException

Parameters:

description - Description of the recurring payment. Note: This field must match the corresponding billing agreement description included in the SetExpressCheckout request. Character length and limitations: 127 single-byte alphanumeric characters

Throws:

java.lang.IllegalArgumentException

Method Detail

setMaxFailedPayments

public void setMaxFailedPayments(int number)

Parameters:

number - The number of scheduled payments that can fail before the profile is automatically suspended. An IPN message is sent to the merchant when the specified number of failed payments is reached.

setAutoBillAmount

public void setAutoBillAmount(boolean autoBill)

This field indicates whether you would like PayPal to automatically bill the outstanding balance amount in the next billing cycle. The outstanding balance is the total amount of any previously failed scheduled payments that have yet to be successfully paid.

Parameters:

autoBill - if set to true, AddToNextBilling value is set, otherwise NoAutoBill is used

getNVPRequest

public java.util.Map<java.lang.String,java.lang.String> getNVPRequest()

Description copied from interface: RequestFields

Creates and returns part of the nvp (name value pair) request containing request values

Specified by:

getNVPRequest in interface RequestFields

Returns:

part of the nvp request as a Map

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object