Package paypal.payflow

Class ShipTo

java.lang.Object

paypal.payflow.Address

paypal.payflow.ShipTo

public final class ShipTo
extends Address

Used for shipping address information

Shipping address is destination address information.

Following example shows how to use BillTo.

................. //inv is the Invoice object. ................. *

//Set the Shipping Address details. ShipTo ship = new ShipTo(); ship.setShipToStreet( "123 Main St."); ship.setShipToZip("12345"); inv.setShipTo (ship); .................

Constructor Summary

Constructors

Constructor	Description
ShipTo()	Constructor

Method Summary

Modifier and Type	Method	Description
BillTo	copy()	This method copies the common contents from shipping to billing address.
protected void	generateRequest()
protected Context	getContext()
protected StringBuffer	getRequestBuffer()	Gets the Requestbuffer used for creating the actual request string.
String	getShipCarrier()	Gets the shipping carrier.
String	getShipFromZip()	Gets the ship from zip.
String	getShipMethod()	Gets the shipping method.
String	getShipToCity()	Gets the shipping city
String	getShipToCountry()	Gets the Shipping Country
String	getShipToEmail()	Gets the shipping email.
String	getShipToFirstName()	Gets the shipping first name
String	getShipToLastName()	Gets the last name from the shipping address.
String	getShipToMiddleName()	Gets the middlename from the shipping address.
String	getShipToPhone()	Gets the phone number from the shipping address.
String	getShipToPhone2()	Gets the Phone2 from the shipping address.
String	getShipToState()	Gets the shipping state.
String	getShipToStreet()	Gets the shipping street.
String	getShipToStreet2()	Gets the shipping street2.
String	getShipToZip()	Gets the shipping zip code.
protected void	setContext(Context context)
protected void	setRequestBuffer(StringBuffer value)	sets the StringBuffer to hold the request string.
void	setShipCarrier(String shipCarrier)	Sets the shipping carrier.
void	setShipFromZip(String shipFromZip)	Sets the ship from zip.
void	setShipMethod(String shipMethod)	Sets the shipping method.
void	setShipToCity(String shipToCity)	Sets the shipping city
void	setShipToCountry(String shipToCountry)	Sets the Shipping Country
void	setShipToEmail(String shipToEmail)	Sets the shipping email.
void	setShipToFirstName(String shipToFirstName)	Sets the shipping first name
void	setShipToLastName(String shipToLastName)	Sets the last name in the shipping address.
void	setShipToMiddleName(String shipToMiddleName)	Sets the middlename in the shipping address.
void	setShipToPhone(String shipToPhone)	Sets the phone number in the shipping address.
void	setShipToPhone2(String shipToPhone2)	Sets the Phone2 in the shipping address.
void	setShipToState(String shipToState)	Sets the shipping state.
void	setShipToStreet(String shipToStreet)	Sets the shipping street.
void	setShipToStreet2(String shipToStreet2)	Sets the shipping street2.
void	setShipToZip(String shipToZip)	Sets the shipping zip code.

Methods inherited from class paypal.payflow.Address

getAddressCity, getAddressCountry, getAddressEmail, getAddressFax, getAddressFirstName, getAddressLastName, getAddressMiddleName, getAddressPhone, getAddressPhone2, getAddressState, getAddressStreet, getAddressStreet2, getAddressZip, setAddressCity, setAddressCountry, setAddressEmail, setAddressFax, setAddressFirstName, setAddressLastName, setAddressMiddleName, setAddressPhone, setAddressPhone2, setAddressState, setAddressStreet, setAddressStreet2, setAddressZip

Methods inherited from class java.lang.Object

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

Constructor Details

ShipTo

public ShipTo()

Constructor

Shipping address is destination address information.

Following example shows how to use ShipTo.

................. //inv is the Invoice object. ................. *

//Set the Shipping Address details. ShipTo ship = new ShipTo(); ship.setShipToStreet ("685A E. Middlefield Rd."); ship.ShipToZip ("94043"); inv.setShipTo( ship); .................

Method Details

getShipToCity

public String getShipToCity()

Gets the shipping city

Returns:

String

Maps to Payflow Parameter: SHIPTOCITY

setShipToCity

public void setShipToCity(String shipToCity)

Sets the shipping city

Parameters:

shipToCity - String

Maps to Payflow Parameter: SHIPTOCITY

getShipToCountry

public String getShipToCountry()

Gets the Shipping Country

Returns:

String

Maps to Payflow Parameter: SHIPTOCOUNTRY

setShipToCountry

public void setShipToCountry(String shipToCountry)

Sets the Shipping Country

Parameters:

shipToCountry - String

Maps to Payflow Parameter: SHIPTOCOUNTRY

getShipToEmail

public String getShipToEmail()

Gets the shipping email.

Returns:

String

Maps to Payflow Parameter: SHIPTOEMAIL

setShipToEmail

public void setShipToEmail(String shipToEmail)

Sets the shipping email.

Parameters:

shipToEmail - String

Maps to Payflow Parameter: SHIPTOEMAIL

getShipToFirstName

public String getShipToFirstName()

Gets the shipping first name

Returns:

String

Maps to Payflow Parameter: SHIPTOFIRSTNAME

setShipToFirstName

public void setShipToFirstName(String shipToFirstName)

Sets the shipping first name

Parameters:

shipToFirstName - String

Maps to Payflow Parameter: SHIPTOFIRSTNAME

getShipToLastName

public String getShipToLastName()

Gets the last name from the shipping address.

Returns:

String

Maps to Payflow Parameter: SHIPTOLASTNAME

setShipToLastName

public void setShipToLastName(String shipToLastName)

Sets the last name in the shipping address.

Parameters:

shipToLastName - String

Maps to Payflow Parameter: SHIPTOLASTNAME

getShipToMiddleName

public String getShipToMiddleName()

Gets the middlename from the shipping address.

Returns:

String

Maps to Payflow Parameter: SHIPTOMIDDLENAME

setShipToMiddleName

public void setShipToMiddleName(String shipToMiddleName)

Sets the middlename in the shipping address.

Parameters:

shipToMiddleName - String

Maps to Payflow Parameter: SHIPTOMIDDLENAME

getShipToPhone2

public String getShipToPhone2()

Gets the Phone2 from the shipping address.

Returns:

String

Maps to Payflow Parameter: SHIPTOPHONE2

setShipToPhone2

public void setShipToPhone2(String shipToPhone2)

Sets the Phone2 in the shipping address.

Parameters:

shipToPhone2 - String

Maps to Payflow Parameter: SHIPTOPHONE2

getShipToPhone

public String getShipToPhone()

Gets the phone number from the shipping address.

Returns:

String

Maps to Payflow Parameter: SHIPTOPHONE

setShipToPhone

public void setShipToPhone(String shipToPhone)

Sets the phone number in the shipping address.

Parameters:

shipToPhone - String

Maps to Payflow Parameter: SHIPTOPHONE

getShipToState

public String getShipToState()

Gets the shipping state.

Returns:

String

Maps to Payflow Parameter: SHIPTOSTATE

setShipToState

public void setShipToState(String shipToState)

Sets the shipping state.

Parameters:

shipToState - String

Maps to Payflow Parameter: SHIPTOSTATE

getShipToStreet

public String getShipToStreet()

Gets the shipping street.

Returns:

String

Maps to Payflow Parameter: SHIPTOSTREET

setShipToStreet

public void setShipToStreet(String shipToStreet)

Sets the shipping street.

Parameters:

shipToStreet - String

Maps to Payflow Parameter: SHIPTOSTREET

getShipToStreet2

public String getShipToStreet2()

Gets the shipping street2.

Returns:

String

Maps to Payflow Parameter: SHIPTOSTREET2

setShipToStreet2

public void setShipToStreet2(String shipToStreet2)

Sets the shipping street2.

Parameters:

shipToStreet2 - String

Maps to Payflow Parameter: SHIPTOSTREET2

getShipToZip

public String getShipToZip()

Gets the shipping zip code.

Returns:

String

Maps to Payflow Parameter: SHIPTOZIP

setShipToZip

public void setShipToZip(String shipToZip)

Sets the shipping zip code.

Parameters:

shipToZip - String

Maps to Payflow Parameter: SHIPTOZIP.

getShipMethod

public String getShipMethod()

Gets the shipping method.

Returns:

String

Maps to Payflow Parameter: SHIPMETHOD

setShipMethod

public void setShipMethod(String shipMethod)

Sets the shipping method.

Parameters:

shipMethod - String

Maps to Payflow Parameter: SHIPMETHOD

getShipCarrier

public String getShipCarrier()

Gets the shipping carrier.

Returns:

String

Maps to Payflow Parameter: SHIPCARRIER

setShipCarrier

public void setShipCarrier(String shipCarrier)

Sets the shipping carrier.

Parameters:

shipCarrier - String

Maps to Payflow Parameter: SHIPCARRIER

getShipFromZip

public String getShipFromZip()

Gets the ship from zip.

Ship from postal code (called ZIP code in the USA).

Returns:

String

Maps to Payflow Parameter: SHIPFROMZIP

setShipFromZip

public void setShipFromZip(String shipFromZip)

Sets the ship from zip.

Ship from postal code (called ZIP code in the USA).

Parameters:

shipFromZip - String

Maps to Payflow Parameter: SHIPFROMZIP

copy

public BillTo copy()

This method copies the common contents from shipping to billing address.

Returns:

BillTo

This method can be used to populate the shipping addresses directly from the billing addresses when both are the same.

................ //ship is the object of //shipTo populated with //the shipping addresses. ................ *

BillTo bill; *

//Populate billing addresses //from shipping addresses. bill = ship.copy(); *

................

generateRequest

protected void generateRequest()

getContext

protected Context getContext()

setContext

protected void setContext(Context context)

getRequestBuffer

protected StringBuffer getRequestBuffer()

Gets the Requestbuffer used for creating the actual request string.

Returns:

mRequestBuffer StringBuffer

setRequestBuffer

protected void setRequestBuffer(StringBuffer value)

sets the StringBuffer to hold the request string.

Parameters:

value - StringBuffer