Coupon (Bing Ads Java SDK 13.0.19 API)

java.lang.Object
- com.microsoft.bingads.v13.customerbilling.Coupon

public class Coupon
extends Object

Java class for Coupon complex type.

The following schema fragment specifies the expected content contained within this class.


 <complexType name="Coupon">
   <complexContent>
     <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
       <sequence>
         <element name="CouponCode" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
         <element name="ClassName" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
         <element name="CouponType" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
         <element name="Amount" type="{http://www.w3.org/2001/XMLSchema}double" minOccurs="0"/>
         <element name="SpendThreshold" type="{http://www.w3.org/2001/XMLSchema}double" minOccurs="0"/>
         <element name="CurrencyCode" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
         <element name="PercentOff" type="{http://www.w3.org/2001/XMLSchema}double" minOccurs="0"/>
         <element name="ActiveDuration" type="{http://www.w3.org/2001/XMLSchema}int" minOccurs="0"/>
         <element name="ExpirationDate" type="{http://www.w3.org/2001/XMLSchema}dateTime" minOccurs="0"/>
         <element name="StartDate" type="{http://www.w3.org/2001/XMLSchema}dateTime" minOccurs="0"/>
         <element name="EndDate" type="{http://www.w3.org/2001/XMLSchema}dateTime" minOccurs="0"/>
         <element name="SendToEmail" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
         <element name="SendToDate" type="{http://www.w3.org/2001/XMLSchema}dateTime" minOccurs="0"/>
         <element name="IsRedeemed" type="{http://www.w3.org/2001/XMLSchema}boolean" minOccurs="0"/>
         <element name="RedemptionInfo" type="{https://bingads.microsoft.com/Customer/v13/Entities}CouponRedemption" minOccurs="0"/>
         <element name="ClaimInfo" type="{https://bingads.microsoft.com/Customer/v13/Entities}CouponClaimInfo" minOccurs="0"/>
       </sequence>
     </restriction>
   </complexContent>
 </complexType>

Field Summary

Fields
Modifier and Type	Field and Description
`protected Integer`	`activeDuration`
`protected Double`	`amount`
`protected CouponClaimInfo`	`claimInfo`
`protected String`	`className`
`protected String`	`couponCode`
`protected String`	`couponType`
`protected String`	`currencyCode`
`protected Calendar`	`endDate`
`protected Calendar`	`expirationDate`
`protected Boolean`	`isRedeemed`
`protected Double`	`percentOff`
`protected CouponRedemption`	`redemptionInfo`
`protected Calendar`	`sendToDate`
`protected String`	`sendToEmail`
`protected Double`	`spendThreshold`
`protected Calendar`	`startDate`

Constructor Summary

Constructors
Constructor and Description

Coupon()

Constructors
Constructor and Description
`Coupon()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Integer`	`getActiveDuration()` Gets the value of the activeDuration property.
`Double`	`getAmount()` Gets the value of the amount property.
`CouponClaimInfo`	`getClaimInfo()` Gets the value of the claimInfo property.
`String`	`getClassName()` Gets the value of the className property.
`String`	`getCouponCode()` Gets the value of the couponCode property.
`String`	`getCouponType()` Gets the value of the couponType property.
`String`	`getCurrencyCode()` Gets the value of the currencyCode property.
`Calendar`	`getEndDate()` Gets the value of the endDate property.
`Calendar`	`getExpirationDate()` Gets the value of the expirationDate property.
`Boolean`	`getIsRedeemed()` Gets the value of the isRedeemed property.
`Double`	`getPercentOff()` Gets the value of the percentOff property.
`CouponRedemption`	`getRedemptionInfo()` Gets the value of the redemptionInfo property.
`Calendar`	`getSendToDate()` Gets the value of the sendToDate property.
`String`	`getSendToEmail()` Gets the value of the sendToEmail property.
`Double`	`getSpendThreshold()` Gets the value of the spendThreshold property.
`Calendar`	`getStartDate()` Gets the value of the startDate property.
`void`	`setActiveDuration(Integer value)` Sets the value of the activeDuration property.
`void`	`setAmount(Double value)` Sets the value of the amount property.
`void`	`setClaimInfo(CouponClaimInfo value)` Sets the value of the claimInfo property.
`void`	`setClassName(String value)` Sets the value of the className property.
`void`	`setCouponCode(String value)` Sets the value of the couponCode property.
`void`	`setCouponType(String value)` Sets the value of the couponType property.
`void`	`setCurrencyCode(String value)` Sets the value of the currencyCode property.
`void`	`setEndDate(Calendar value)` Sets the value of the endDate property.
`void`	`setExpirationDate(Calendar value)` Sets the value of the expirationDate property.
`void`	`setIsRedeemed(Boolean value)` Sets the value of the isRedeemed property.
`void`	`setPercentOff(Double value)` Sets the value of the percentOff property.
`void`	`setRedemptionInfo(CouponRedemption value)` Sets the value of the redemptionInfo property.
`void`	`setSendToDate(Calendar value)` Sets the value of the sendToDate property.
`void`	`setSendToEmail(String value)` Sets the value of the sendToEmail property.
`void`	`setSpendThreshold(Double value)` Sets the value of the spendThreshold property.
`void`	`setStartDate(Calendar value)` Sets the value of the startDate property.

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

- Field Detail
  - couponCode
```
protected String couponCode
```
  - className
```
protected String className
```
  - couponType
```
protected String couponType
```
  - amount
```
protected Double amount
```
  - spendThreshold
```
protected Double spendThreshold
```
  - currencyCode
```
protected String currencyCode
```
  - percentOff
```
protected Double percentOff
```
  - activeDuration
```
protected Integer activeDuration
```
  - expirationDate
```
protected Calendar expirationDate
```
  - startDate
```
protected Calendar startDate
```
  - endDate
```
protected Calendar endDate
```
  - sendToEmail
```
protected String sendToEmail
```
  - sendToDate
```
protected Calendar sendToDate
```
  - isRedeemed
```
protected Boolean isRedeemed
```
  - redemptionInfo
```
protected CouponRedemption redemptionInfo
```
  - claimInfo
```
protected CouponClaimInfo claimInfo
```
- Constructor Detail
  - Coupon
```
public Coupon()
```
- Method Detail
  - getCouponCode
```
public String getCouponCode()
```
    Gets the value of the couponCode property.
    
    Returns:
    
    possible object is String
  - setCouponCode
```
public void setCouponCode(String value)
```
    Sets the value of the couponCode property.
    
    Parameters:
    
    value - allowed object is String
  - getClassName
```
public String getClassName()
```
    Gets the value of the className property.
    
    Returns:
    
    possible object is String
  - setClassName
```
public void setClassName(String value)
```
    Sets the value of the className property.
    
    Parameters:
    
    value - allowed object is String
  - getCouponType
```
public String getCouponType()
```
    Gets the value of the couponType property.
    
    Returns:
    
    possible object is String
  - setCouponType
```
public void setCouponType(String value)
```
    Sets the value of the couponType property.
    
    Parameters:
    
    value - allowed object is String
  - getAmount
```
public Double getAmount()
```
    Gets the value of the amount property.
    
    Returns:
    
    possible object is Double
  - setAmount
```
public void setAmount(Double value)
```
    Sets the value of the amount property.
    
    Parameters:
    
    value - allowed object is Double
  - getSpendThreshold
```
public Double getSpendThreshold()
```
    Gets the value of the spendThreshold property.
    
    Returns:
    
    possible object is Double
  - setSpendThreshold
```
public void setSpendThreshold(Double value)
```
    Sets the value of the spendThreshold property.
    
    Parameters:
    
    value - allowed object is Double
  - getCurrencyCode
```
public String getCurrencyCode()
```
    Gets the value of the currencyCode property.
    
    Returns:
    
    possible object is String
  - setCurrencyCode
```
public void setCurrencyCode(String value)
```
    Sets the value of the currencyCode property.
    
    Parameters:
    
    value - allowed object is String
  - getPercentOff
```
public Double getPercentOff()
```
    Gets the value of the percentOff property.
    
    Returns:
    
    possible object is Double
  - setPercentOff
```
public void setPercentOff(Double value)
```
    Sets the value of the percentOff property.
    
    Parameters:
    
    value - allowed object is Double
  - getActiveDuration
```
public Integer getActiveDuration()
```
    Gets the value of the activeDuration property.
    
    Returns:
    
    possible object is Integer
  - setActiveDuration
```
public void setActiveDuration(Integer value)
```
    Sets the value of the activeDuration property.
    
    Parameters:
    
    value - allowed object is Integer
  - getExpirationDate
```
public Calendar getExpirationDate()
```
    Gets the value of the expirationDate property.
    
    Returns:
    
    possible object is String
  - setExpirationDate
```
public void setExpirationDate(Calendar value)
```
    Sets the value of the expirationDate property.
    
    Parameters:
    
    value - allowed object is String
  - getStartDate
```
public Calendar getStartDate()
```
    Gets the value of the startDate property.
    
    Returns:
    
    possible object is String
  - setStartDate
```
public void setStartDate(Calendar value)
```
    Sets the value of the startDate property.
    
    Parameters:
    
    value - allowed object is String
  - getEndDate
```
public Calendar getEndDate()
```
    Gets the value of the endDate property.
    
    Returns:
    
    possible object is String
  - setEndDate
```
public void setEndDate(Calendar value)
```
    Sets the value of the endDate property.
    
    Parameters:
    
    value - allowed object is String
  - getSendToEmail
```
public String getSendToEmail()
```
    Gets the value of the sendToEmail property.
    
    Returns:
    
    possible object is String
  - setSendToEmail
```
public void setSendToEmail(String value)
```
    Sets the value of the sendToEmail property.
    
    Parameters:
    
    value - allowed object is String
  - getSendToDate
```
public Calendar getSendToDate()
```
    Gets the value of the sendToDate property.
    
    Returns:
    
    possible object is String
  - setSendToDate
```
public void setSendToDate(Calendar value)
```
    Sets the value of the sendToDate property.
    
    Parameters:
    
    value - allowed object is String
  - getIsRedeemed
```
public Boolean getIsRedeemed()
```
    Gets the value of the isRedeemed property.
    
    Returns:
    
    possible object is Boolean
  - setIsRedeemed
```
public void setIsRedeemed(Boolean value)
```
    Sets the value of the isRedeemed property.
    
    Parameters:
    
    value - allowed object is Boolean
  - getRedemptionInfo
```
public CouponRedemption getRedemptionInfo()
```
    Gets the value of the redemptionInfo property.
    
    Returns:
    
    possible object is CouponRedemption
  - setRedemptionInfo
```
public void setRedemptionInfo(CouponRedemption value)
```
    Sets the value of the redemptionInfo property.
    
    Parameters:
    
    value - allowed object is CouponRedemption
  - getClaimInfo
```
public CouponClaimInfo getClaimInfo()
```
    Gets the value of the claimInfo property.
    
    Returns:
    
    possible object is CouponClaimInfo
  - setClaimInfo
```
public void setClaimInfo(CouponClaimInfo value)
```
    Sets the value of the claimInfo property.
    
    Parameters:
    
    value - allowed object is CouponClaimInfo

Class Coupon

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

couponCode

className

couponType

amount

spendThreshold

currencyCode

percentOff

activeDuration

expirationDate

startDate

endDate

sendToEmail

sendToDate

isRedeemed

redemptionInfo

claimInfo

Constructor Detail

Coupon

Method Detail

getCouponCode

setCouponCode

getClassName

setClassName

getCouponType

setCouponType

getAmount

setAmount

getSpendThreshold

setSpendThreshold

getCurrencyCode

setCurrencyCode

getPercentOff

setPercentOff

getActiveDuration

setActiveDuration

getExpirationDate

setExpirationDate

getStartDate

setStartDate

getEndDate

setEndDate

getSendToEmail

setSendToEmail

getSendToDate

setSendToDate

getIsRedeemed

setIsRedeemed

getRedemptionInfo

setRedemptionInfo

getClaimInfo

setClaimInfo