com.shopify.buy3

Class Storefront.SellingPlan

java.lang.Object

com.shopify.graphql.support.AbstractResponse<Storefront.SellingPlan>

com.shopify.buy3.Storefront.SellingPlan

All Implemented Interfaces:

java.io.Serializable

Enclosing class:

Storefront

public static class Storefront.SellingPlan
extends AbstractResponse<Storefront.SellingPlan>

Represents how products and variants can be sold and purchased.

See Also:

Serialized Form

Field Summary

Fields inherited from class com.shopify.graphql.support.AbstractResponse

optimisticData, responseData

Constructor Summary

Constructors

Constructor and Description
SellingPlan()
SellingPlan(JsonObject fields)

Method Summary

Modifier and Type	Method and Description
Storefront.SellingPlanCheckoutCharge	getCheckoutCharge() The initial payment due for the purchase.
java.lang.String	getDescription() The description of the selling plan.
java.lang.String	getGraphQlTypeName()
ID	getId() A globally-unique identifier.
java.lang.String	getName() The name of the selling plan.
java.util.List<Storefront.SellingPlanOption>	getOptions() The selling plan options available in the drop-down list in the storefront.
java.util.List<Storefront.SellingPlanPriceAdjustment>	getPriceAdjustments() The price adjustments that a selling plan makes when a variant is purchased with a selling plan.
java.lang.Boolean	getRecurringDeliveries() Whether purchasing the selling plan will result in multiple deliveries.
Storefront.SellingPlan	setCheckoutCharge(Storefront.SellingPlanCheckoutCharge arg)
Storefront.SellingPlan	setDescription(java.lang.String arg)
Storefront.SellingPlan	setId(ID arg)
Storefront.SellingPlan	setName(java.lang.String arg)
Storefront.SellingPlan	setOptions(java.util.List<Storefront.SellingPlanOption> arg)
Storefront.SellingPlan	setPriceAdjustments(java.util.List<Storefront.SellingPlanPriceAdjustment> arg)
Storefront.SellingPlan	setRecurringDeliveries(java.lang.Boolean arg)
boolean	unwrapsToObject(java.lang.String key)

Methods inherited from class com.shopify.graphql.support.AbstractResponse

collectNodes, get, getFieldName, getKey, jsonAsArray, jsonAsBoolean, jsonAsDouble, jsonAsInteger, jsonAsObject, jsonAsString, withAlias

Methods inherited from class java.lang.Object

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

Constructor Detail

SellingPlan

public SellingPlan()

SellingPlan

public SellingPlan(JsonObject fields)
            throws SchemaViolationError

Throws:

SchemaViolationError

Method Detail

getGraphQlTypeName

public java.lang.String getGraphQlTypeName()

getCheckoutCharge

public Storefront.SellingPlanCheckoutCharge getCheckoutCharge()

The initial payment due for the purchase.

setCheckoutCharge

public Storefront.SellingPlan setCheckoutCharge(Storefront.SellingPlanCheckoutCharge arg)

getDescription

public java.lang.String getDescription()

The description of the selling plan.

setDescription

public Storefront.SellingPlan setDescription(java.lang.String arg)

getId

public ID getId()

A globally-unique identifier.

setId

public Storefront.SellingPlan setId(ID arg)

getName

public java.lang.String getName()

The name of the selling plan. For example, '6 weeks of prepaid granola, delivered weekly'.

setName

public Storefront.SellingPlan setName(java.lang.String arg)

getOptions

public java.util.List<Storefront.SellingPlanOption> getOptions()

The selling plan options available in the drop-down list in the storefront. For example, 'Delivery every week' or 'Delivery every 2 weeks' specifies the delivery frequency options for the product. Individual selling plans contribute their options to the associated selling plan group. For example, a selling plan group might have an option called `option1: Delivery every`. One selling plan in that group could contribute `option1: 2 weeks` with the pricing for that option, and another selling plan could contribute `option1: 4 weeks`, with different pricing.

setOptions

public Storefront.SellingPlan setOptions(java.util.List<Storefront.SellingPlanOption> arg)

getPriceAdjustments

public java.util.List<Storefront.SellingPlanPriceAdjustment> getPriceAdjustments()

The price adjustments that a selling plan makes when a variant is purchased with a selling plan.

setPriceAdjustments

public Storefront.SellingPlan setPriceAdjustments(java.util.List<Storefront.SellingPlanPriceAdjustment> arg)

getRecurringDeliveries

public java.lang.Boolean getRecurringDeliveries()

Whether purchasing the selling plan will result in multiple deliveries.

setRecurringDeliveries

public Storefront.SellingPlan setRecurringDeliveries(java.lang.Boolean arg)

unwrapsToObject

public boolean unwrapsToObject(java.lang.String key)

Specified by:

unwrapsToObject in class AbstractResponse<Storefront.SellingPlan>