GiftCardOrderItem (Magento GraphQL data models and query builders 9.1.0-magento242ee API)

java.lang.Object
- com.shopify.graphql.support.AbstractResponse<GiftCardOrderItem>
- - com.adobe.cq.commerce.magento.graphql.GiftCardOrderItem

All Implemented Interfaces:: OrderItemInterface, CustomFieldInterface, Serializable

public class GiftCardOrderItem
extends AbstractResponse<GiftCardOrderItem>
implements OrderItemInterface

See Also:: Serialized Form

Field Summary
- Fields inherited from class com.shopify.graphql.support.AbstractResponse
  optimisticData, responseData

Constructor Summary

Constructors
Constructor and Description

GiftCardOrderItem()

GiftCardOrderItem(com.google.gson.JsonObject fields)

Constructors
Constructor and Description
`GiftCardOrderItem()`
`GiftCardOrderItem(com.google.gson.JsonObject fields)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`List<Discount>`	`getDiscounts()` The final discount information for the product
`Boolean`	`getEligibleForReturn()` Indicates whether the order item is eligible is eligible to be in a return request
`List<OrderItemOption>`	`getEnteredOptions()` The entered option for the base product, such as a logo or image
`GiftCardItem`	`getGiftCard()` Selected gift card properties for an order item
`GiftWrapping`	`getGiftWrapping()` The selected gift wrapping for the order item
`String`	`getGraphQlTypeName()`
`ID`	`getId()` The unique ID for a `OrderItemInterface` object
`String`	`getProductName()` The name of the base product
`Money`	`getProductSalePrice()` The sale price of the base product, including selected options
`String`	`getProductSku()` The SKU of the base product
`String`	`getProductType()` The type of product, such as simple, configurable, etc.
`String`	`getProductUrlKey()` URL key of the base product
`Double`	`getQuantityCanceled()` The number of canceled items
`Double`	`getQuantityInvoiced()` The number of invoiced items
`Double`	`getQuantityOrdered()` The number of units ordered for this item
`Double`	`getQuantityRefunded()` The number of refunded items
`Double`	`getQuantityReturned()` The number of returned items
`Double`	`getQuantityShipped()` The number of shipped items
`List<OrderItemOption>`	`getSelectedOptions()` The selected options for the base product, such as color or size
`String`	`getStatus()` The status of the order item
`GiftCardOrderItem`	`setDiscounts(List<Discount> arg)`
`GiftCardOrderItem`	`setEligibleForReturn(Boolean arg)`
`GiftCardOrderItem`	`setEnteredOptions(List<OrderItemOption> arg)`
`GiftCardOrderItem`	`setGiftCard(GiftCardItem arg)`
`GiftCardOrderItem`	`setGiftWrapping(GiftWrapping arg)`
`GiftCardOrderItem`	`setId(ID arg)`
`GiftCardOrderItem`	`setProductName(String arg)`
`GiftCardOrderItem`	`setProductSalePrice(Money arg)`
`GiftCardOrderItem`	`setProductSku(String arg)`
`GiftCardOrderItem`	`setProductType(String arg)`
`GiftCardOrderItem`	`setProductUrlKey(String arg)`
`GiftCardOrderItem`	`setQuantityCanceled(Double arg)`
`GiftCardOrderItem`	`setQuantityInvoiced(Double arg)`
`GiftCardOrderItem`	`setQuantityOrdered(Double arg)`
`GiftCardOrderItem`	`setQuantityRefunded(Double arg)`
`GiftCardOrderItem`	`setQuantityReturned(Double arg)`
`GiftCardOrderItem`	`setQuantityShipped(Double arg)`
`GiftCardOrderItem`	`setSelectedOptions(List<OrderItemOption> arg)`
`GiftCardOrderItem`	`setStatus(String arg)`
`boolean`	`unwrapsToObject(String key)`

Methods inherited from class com.shopify.graphql.support.AbstractResponse
collectNodes, get, getAsArray, getAsBoolean, getAsDouble, getAsInteger, getAsString, getFieldName, getKey, jsonAsArray, jsonAsBoolean, jsonAsDouble, jsonAsInteger, jsonAsObject, jsonAsString, readCustomField, withAlias

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.shopify.graphql.support.CustomFieldInterface
get, getAsArray, getAsBoolean, getAsDouble, getAsInteger, getAsString

- Constructor Detail
  - GiftCardOrderItem
```
public GiftCardOrderItem()
```
  - GiftCardOrderItem
```
public GiftCardOrderItem(com.google.gson.JsonObject fields)
                  throws SchemaViolationError
```
    Throws:
    
    SchemaViolationError
- Method Detail
  - getGraphQlTypeName
```
public String getGraphQlTypeName()
```
    Specified by:
    
    getGraphQlTypeName in interface OrderItemInterface
  - getDiscounts
```
public List<Discount> getDiscounts()
```
    The final discount information for the product
    
    Specified by:
    
    getDiscounts in interface OrderItemInterface
  - setDiscounts
```
public GiftCardOrderItem setDiscounts(List<Discount> arg)
```
  - getEligibleForReturn
```
public Boolean getEligibleForReturn()
```
    Indicates whether the order item is eligible is eligible to be in a return request
    
    Specified by:
    
    getEligibleForReturn in interface OrderItemInterface
  - setEligibleForReturn
```
public GiftCardOrderItem setEligibleForReturn(Boolean arg)
```
  - getEnteredOptions
```
public List<OrderItemOption> getEnteredOptions()
```
    The entered option for the base product, such as a logo or image
    
    Specified by:
    
    getEnteredOptions in interface OrderItemInterface
  - setEnteredOptions
```
public GiftCardOrderItem setEnteredOptions(List<OrderItemOption> arg)
```
  - getGiftCard
```
public GiftCardItem getGiftCard()
```
    Selected gift card properties for an order item
  - setGiftCard
```
public GiftCardOrderItem setGiftCard(GiftCardItem arg)
```
  - getGiftWrapping
```
public GiftWrapping getGiftWrapping()
```
    The selected gift wrapping for the order item
    
    Specified by:
    
    getGiftWrapping in interface OrderItemInterface
  - setGiftWrapping
```
public GiftCardOrderItem setGiftWrapping(GiftWrapping arg)
```
  - getId
```
public ID getId()
```
    The unique ID for a `OrderItemInterface` object
    
    Specified by:
    
    getId in interface OrderItemInterface
  - setId
```
public GiftCardOrderItem setId(ID arg)
```
  - getProductName
```
public String getProductName()
```
    The name of the base product
    
    Specified by:
    
    getProductName in interface OrderItemInterface
  - setProductName
```
public GiftCardOrderItem setProductName(String arg)
```
  - getProductSalePrice
```
public Money getProductSalePrice()
```
    The sale price of the base product, including selected options
    
    Specified by:
    
    getProductSalePrice in interface OrderItemInterface
  - setProductSalePrice
```
public GiftCardOrderItem setProductSalePrice(Money arg)
```
  - getProductSku
```
public String getProductSku()
```
    The SKU of the base product
    
    Specified by:
    
    getProductSku in interface OrderItemInterface
  - setProductSku
```
public GiftCardOrderItem setProductSku(String arg)
```
  - getProductType
```
public String getProductType()
```
    The type of product, such as simple, configurable, etc.
    
    Specified by:
    
    getProductType in interface OrderItemInterface
  - setProductType
```
public GiftCardOrderItem setProductType(String arg)
```
  - getProductUrlKey
```
public String getProductUrlKey()
```
    URL key of the base product
    
    Specified by:
    
    getProductUrlKey in interface OrderItemInterface
  - setProductUrlKey
```
public GiftCardOrderItem setProductUrlKey(String arg)
```
  - getQuantityCanceled
```
public Double getQuantityCanceled()
```
    The number of canceled items
    
    Specified by:
    
    getQuantityCanceled in interface OrderItemInterface
  - setQuantityCanceled
```
public GiftCardOrderItem setQuantityCanceled(Double arg)
```
  - getQuantityInvoiced
```
public Double getQuantityInvoiced()
```
    The number of invoiced items
    
    Specified by:
    
    getQuantityInvoiced in interface OrderItemInterface
  - setQuantityInvoiced
```
public GiftCardOrderItem setQuantityInvoiced(Double arg)
```
  - getQuantityOrdered
```
public Double getQuantityOrdered()
```
    The number of units ordered for this item
    
    Specified by:
    
    getQuantityOrdered in interface OrderItemInterface
  - setQuantityOrdered
```
public GiftCardOrderItem setQuantityOrdered(Double arg)
```
  - getQuantityRefunded
```
public Double getQuantityRefunded()
```
    The number of refunded items
    
    Specified by:
    
    getQuantityRefunded in interface OrderItemInterface
  - setQuantityRefunded
```
public GiftCardOrderItem setQuantityRefunded(Double arg)
```
  - getQuantityReturned
```
public Double getQuantityReturned()
```
    The number of returned items
    
    Specified by:
    
    getQuantityReturned in interface OrderItemInterface
  - setQuantityReturned
```
public GiftCardOrderItem setQuantityReturned(Double arg)
```
  - getQuantityShipped
```
public Double getQuantityShipped()
```
    The number of shipped items
    
    Specified by:
    
    getQuantityShipped in interface OrderItemInterface
  - setQuantityShipped
```
public GiftCardOrderItem setQuantityShipped(Double arg)
```
  - getSelectedOptions
```
public List<OrderItemOption> getSelectedOptions()
```
    The selected options for the base product, such as color or size
    
    Specified by:
    
    getSelectedOptions in interface OrderItemInterface
  - setSelectedOptions
```
public GiftCardOrderItem setSelectedOptions(List<OrderItemOption> arg)
```
  - getStatus
```
public String getStatus()
```
    The status of the order item
    
    Specified by:
    
    getStatus in interface OrderItemInterface
  - setStatus
```
public GiftCardOrderItem setStatus(String arg)
```
  - unwrapsToObject
```
public boolean unwrapsToObject(String key)
```
    Specified by:
    
    unwrapsToObject in class AbstractResponse<GiftCardOrderItem>

Class GiftCardOrderItem

Field Summary

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

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

Methods inherited from interface com.shopify.graphql.support.CustomFieldInterface

Constructor Detail

GiftCardOrderItem

GiftCardOrderItem

Method Detail

getGraphQlTypeName

getDiscounts

setDiscounts

getEligibleForReturn

setEligibleForReturn

getEnteredOptions

setEnteredOptions

getGiftCard

setGiftCard

getGiftWrapping

setGiftWrapping

getId

setId

getProductName

setProductName

getProductSalePrice

setProductSalePrice

getProductSku

setProductSku

getProductType

setProductType

getProductUrlKey

setProductUrlKey

getQuantityCanceled

setQuantityCanceled

getQuantityInvoiced

setQuantityInvoiced

getQuantityOrdered

setQuantityOrdered

getQuantityRefunded

setQuantityRefunded

getQuantityReturned

setQuantityReturned

getQuantityShipped

setQuantityShipped

getSelectedOptions

setSelectedOptions

getStatus

setStatus

unwrapsToObject