paypalnvp.request
Class DoVoid

java.lang.Object
  paypalnvp.request.DoVoid

All Implemented Interfaces:

java.io.Serializable, Request

public final class DoVoid
extends java.lang.Object
implements Request

Void an order or an authorization.

See Also:

Serialized Form

Constructor Summary

DoVoid(java.lang.String authorizationId)

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
java.util.Map<java.lang.String,java.lang.String>	getNVPResponse() Return response from paypal.
void	setNote(java.lang.String note) An informational note about this settlement that is displayed to the payer in email and in his transaction history.
void	setNVPResponse(java.util.Map<java.lang.String,java.lang.String> nvpResponse) Setter for nvp (name value pair) response
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

DoVoid

public DoVoid(java.lang.String authorizationId)
       throws java.lang.IllegalArgumentException

Parameters:

authorizationId - The value of the original authorization identification number returned by a PayPal product. IMPORTANT: If you are voiding a transaction that has been reauthorized, use the ID from the original authorization, and not the reauthorization. Character length and limits: 19 single-byte characters.

Throws:

java.lang.IllegalArgumentException

Method Detail

setNote

public void setNote(java.lang.String note)
             throws java.lang.IllegalArgumentException

An informational note about this settlement that is displayed to the payer in email and in his transaction history.

Parameters:

note - Character length and limits: 255 single-byte characters.

Throws:

java.lang.IllegalArgumentException

getNVPRequest

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

Description copied from interface: Request

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

Specified by:

getNVPRequest in interface Request

Returns:

part of the nvp request as a Map

setNVPResponse

public void setNVPResponse(java.util.Map<java.lang.String,java.lang.String> nvpResponse)

Description copied from interface: Request

Setter for nvp (name value pair) response

Specified by:

setNVPResponse in interface Request

getNVPResponse

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

Description copied from interface: Request

Return response from paypal. If response is not set/received returns empty Map.

Specified by:

getNVPResponse in interface Request

Returns:

response from paypal as a Map

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object