Class GiftCertificateLineItem
Represents a Gift Certificate line item in the cart. When an order is
processed, a Gift Certificate is created based on the information in
the Gift Certificate line item.
Property Summary
Constructor Summary
This class does not have a constructor, so you cannot create it directly.
Method Summary
Method Description getGiftCertificateID ()Returns the ID of the gift certificate that this line item was used to create. getMessage ()Returns the message to include in the email of the person receiving the gift certificate line item. getProductListItem ()Returns the associated ProductListItem. getRecipientEmail ()Returns the email address of the person receiving the gift certificate line item. getRecipientName ()Returns the name of the person receiving the gift certificate line item. getSenderName ()Returns the name of the person or organization that sent the gift certificate line item or null if undefined. getShipment ()Returns the associated Shipment. setGiftCertificateID (String )Sets the ID of the gift certificate associated with this line item. setMessage (String )Sets the message to include in the email of the person receiving the gift certificate line item. setProductListItem (ProductListItem )Sets the associated ProductListItem. setRecipientEmail (String )Sets the email address of the person receiving the gift certificate line item. setRecipientName (String )Sets the name of the person receiving the gift certificate line item. setSenderName (String )Sets the name of the person or organization that sent the gift certificate line item. setShipment (Shipment )Associates the gift certificate line item with the specified shipment.
Methods inherited from class LineItem
getBasePrice , getGrossPrice , getLineItemCtnr , getLineItemText , getNetPrice , getPrice , getPriceValue , getTax , getTaxBasis , getTaxClassID , getTaxRate , setBasePrice , setGrossPrice , setLineItemText , setNetPrice , setPriceValue , setTax , setTaxClassID , setTaxRate , updatePrice , updateTax , updateTax , updateTaxAmount
Methods inherited from class ExtensibleObject
describe , getCustom
Methods inherited from class PersistentObject
getCreationDate , getLastModified , getUUID
Methods inherited from class Object
assign , create , create , defineProperties , defineProperty , entries , freeze , fromEntries , getOwnPropertyDescriptor , getOwnPropertyNames , getOwnPropertySymbols , getPrototypeOf , hasOwnProperty , is , isExtensible , isFrozen , isPrototypeOf , isSealed , keys , preventExtensions , propertyIsEnumerable , seal , setPrototypeOf , toLocaleString , toString , valueOf , values
Property Details
giftCertificateID
giftCertificateID: String
Returns the ID of the gift certificate that this line item
was used to create. If this line item has not been used to create
a Gift Certificate, this method returns null.
message
message: String
Returns the message to include in the email of the person receiving
the gift certificate line item.
productListItem
productListItem: ProductListItem
Returns the associated ProductListItem.
recipientEmail
recipientEmail: String
Returns the email address of the person receiving
the gift certificate line item.
recipientName
recipientName: String
Returns the name of the person receiving the gift certificate line item.
senderName
senderName: String
Returns the name of the person or organization that
sent the gift certificate line item or null if undefined.
shipment
shipment: Shipment
Returns the associated Shipment.
Method Details
getGiftCertificateID()
getGiftCertificateID(): String
Returns the ID of the gift certificate that this line item
was used to create. If this line item has not been used to create
a Gift Certificate, this method returns null.
Returns:
the ID of the gift certificate or null if undefined.
getMessage()
getMessage(): String
Returns the message to include in the email of the person receiving
the gift certificate line item.
Returns:
the message to include in the email of the person receiving
the gift certificate line item.
getProductListItem()
getProductListItem(): ProductListItem
Returns the associated ProductListItem.
Returns:
getRecipientEmail()
getRecipientEmail(): String
Returns the email address of the person receiving
the gift certificate line item.
Returns:
the email address of the person receiving
the gift certificate line item.
getRecipientName()
getRecipientName(): String
Returns the name of the person receiving the gift certificate line item.
Returns:
the name of the person receiving the gift certificate line item.
getSenderName()
getSenderName(): String
Returns the name of the person or organization that
sent the gift certificate line item or null if undefined.
Returns:
the name of the person or organization that
sent the gift certificate line item or null if undefined.
getShipment()
getShipment(): Shipment
Returns the associated Shipment.
Returns:
The shipment of the gift certificate line item
setGiftCertificateID(String)
setGiftCertificateID(id: String ): void
Sets the ID of the gift certificate associated with this line item.
Parameters:
id - the ID of the gift certificate associated with this line item.
setMessage(String)
setMessage(message: String ): void
Sets the message to include in the email of the person receiving
the gift certificate line item.
Parameters:
message - the message to include in the email of the person receiving the gift certificate line item.
setProductListItem(ProductListItem)
setProductListItem(productListItem: ProductListItem ): void
Sets the associated ProductListItem.
The product list item to be set must be of type gift certificate otherwise an exception is thrown.
Parameters:
productListItem - the product list item to be associated
setRecipientEmail(String)
setRecipientEmail(recipientEmail: String ): void
Sets the email address of the person receiving
the gift certificate line item.
Parameters:
recipientEmail - the email address of the person receiving the gift certificate line item.
setRecipientName(String)
setRecipientName(recipient: String ): void
Sets the name of the person receiving the gift certificate line item.
Parameters:
recipient - the name of the person receiving the gift certificate line item.
setSenderName(String)
setSenderName(sender: String ): void
Sets the name of the person or organization that
sent the gift certificate line item.
Parameters:
sender - the name of the person or organization that sent the gift certificate line item.
setShipment(Shipment)
setShipment(shipment: Shipment ): void
Associates the gift certificate line item with the specified shipment.
Gift certificate line item and shipment must belong to the same line item ctnr.
Parameters:
shipment - The new shipment of the gift certificate line item
j