com.paypal.sdk.models

Class ShippingOption

java.lang.Object

com.paypal.sdk.models.ShippingOption

public class ShippingOption
extends Object

This is a model class for ShippingOption type.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ShippingOption.Builder Class to build instances of ShippingOption.

Constructor Summary

Constructors

Constructor and Description
ShippingOption() Default constructor.
ShippingOption(String id, String label, boolean selected, ShippingType type, Money amount) Initialization constructor.

Method Summary

Modifier and Type	Method and Description
Money	getAmount() Getter for Amount.
String	getId() Getter for Id.
String	getLabel() Getter for Label.
boolean	getSelected() Getter for Selected.
ShippingType	getType() Getter for Type.
void	setAmount(Money amount) Setter for Amount.
void	setId(String id) Setter for Id.
void	setLabel(String label) Setter for Label.
void	setSelected(boolean selected) Setter for Selected.
void	setType(ShippingType type) Setter for Type.
ShippingOption.Builder	toBuilder() Builds a new ShippingOption.Builder object.
String	toString() Converts this ShippingOption into string format.

Methods inherited from class java.lang.Object

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

Constructor Detail

ShippingOption

public ShippingOption()

Default constructor.

ShippingOption

public ShippingOption(String id,
                      String label,
                      boolean selected,
                      ShippingType type,
                      Money amount)

Initialization constructor.

Parameters:

id - String value for id.

label - String value for label.

selected - boolean value for selected.

type - ShippingType value for type.

amount - Money value for amount.

Method Detail

getId

public String getId()

Getter for Id. A unique ID that identifies a payer-selected shipping option.

Returns:

Returns the String

setId

public void setId(String id)

Setter for Id. A unique ID that identifies a payer-selected shipping option.

Parameters:

id - Value for String

getLabel

public String getLabel()

Getter for Label. A description that the payer sees, which helps them choose an appropriate shipping option. For example, `Free Shipping`, `USPS Priority Shipping`, `Expédition prioritaire USPS`, or `USPS yōuxiān fā huò`. Localize this description to the payer's locale.

Returns:

Returns the String

setLabel

public void setLabel(String label)

Setter for Label. A description that the payer sees, which helps them choose an appropriate shipping option. For example, `Free Shipping`, `USPS Priority Shipping`, `Expédition prioritaire USPS`, or `USPS yōuxiān fā huò`. Localize this description to the payer's locale.

Parameters:

label - Value for String

getType

public ShippingType getType()

Getter for Type. A classification for the method of purchase fulfillment.

Returns:

Returns the ShippingType

setType

public void setType(ShippingType type)

Setter for Type. A classification for the method of purchase fulfillment.

Parameters:

type - Value for ShippingType

getAmount

public Money getAmount()

Getter for Amount. The currency and amount for a financial transaction, such as a balance or payment due.

Returns:

Returns the Money

setAmount

public void setAmount(Money amount)

Setter for Amount. The currency and amount for a financial transaction, such as a balance or payment due.

Parameters:

amount - Value for Money

getSelected

public boolean getSelected()

Getter for Selected. If the API request sets `selected = true`, it represents the shipping option that the payee or merchant expects to be pre-selected for the payer when they first view the `shipping.options` in the PayPal Checkout experience. As part of the response if a `shipping.option` contains `selected=true`, it represents the shipping option that the payer selected during the course of checkout with PayPal. Only one `shipping.option` can be set to `selected=true`.

Returns:

Returns the boolean

setSelected

public void setSelected(boolean selected)

Setter for Selected. If the API request sets `selected = true`, it represents the shipping option that the payee or merchant expects to be pre-selected for the payer when they first view the `shipping.options` in the PayPal Checkout experience. As part of the response if a `shipping.option` contains `selected=true`, it represents the shipping option that the payer selected during the course of checkout with PayPal. Only one `shipping.option` can be set to `selected=true`.

Parameters:

selected - Value for boolean

toString

public String toString()

Converts this ShippingOption into string format.

Overrides:

toString in class Object

Returns:

String representation of this class

toBuilder

public ShippingOption.Builder toBuilder()

Builds a new ShippingOption.Builder object. Creates the instance with the state of the current model.

Returns:

a new ShippingOption.Builder object