java.lang.Object
- com.docusign.esign.model.ReferralInformation

All Implemented Interfaces:

Serializable
```
public class ReferralInformation
extends Object
implements Serializable
```
A complex type that contains the following information for entering referral and discount information. The following items are included in the referral information (all string content): enableSupport, includedSeats, saleDiscountPercent, saleDiscountAmount, saleDiscountFixedAmount, saleDiscountPeriods, saleDiscountSeatPriceOverride, planStartMonth, referralCode, referrerName, advertisementId, publisherId, shopperId, promoCode, groupMemberId, idType, and industry ###### Note: saleDiscountPercent, saleDiscountAmount, saleDiscountFixedAmount, saleDiscountPeriods, and saleDiscountSeatPriceOverride are reserved for DoucSign use only..

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor Description

ReferralInformation()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`ReferralInformation`	`advertisementId(String advertisementId)`	advertisementId.
`ReferralInformation`	`enableSupport(String enableSupport)`	enableSupport.
`boolean`	`equals(Object o)`	Compares objects.
`ReferralInformation`	`externalOrgId(String externalOrgId)`	externalOrgId.
`String`	`getAdvertisementId()`	A complex type that contains the following information for entering referral and discount information.
`String`	`getEnableSupport()`	When set to true, then customer support is provided as part of the account plan..
`String`	`getExternalOrgId()`	.
`String`	`getGroupMemberId()`	.
`String`	`getIdType()`	.
`String`	`getIncludedSeats()`	The number of seats (users) included..
`String`	`getIndustry()`	.
`String`	`getPlanStartMonth()`	.
`String`	`getPromoCode()`	.
`String`	`getPublisherId()`	.
`String`	`getReferralCode()`	.
`String`	`getReferrerName()`	.
`String`	`getSaleDiscountAmount()`	Reserved for DocuSign use only..
`String`	`getSaleDiscountFixedAmount()`	Reserved for DocuSign use only..
`String`	`getSaleDiscountPercent()`	Reserved for DocuSign use only..
`String`	`getSaleDiscountPeriods()`	Reserved for DocuSign use only..
`String`	`getSaleDiscountSeatPriceOverride()`	Reserved for DocuSign use only..
`String`	`getShopperId()`	.
`ReferralInformation`	`groupMemberId(String groupMemberId)`	groupMemberId.
`int`	`hashCode()`	Returns the HashCode.
`ReferralInformation`	`idType(String idType)`	idType.
`ReferralInformation`	`includedSeats(String includedSeats)`	includedSeats.
`ReferralInformation`	`industry(String industry)`	industry.
`ReferralInformation`	`planStartMonth(String planStartMonth)`	planStartMonth.
`ReferralInformation`	`promoCode(String promoCode)`	promoCode.
`ReferralInformation`	`publisherId(String publisherId)`	publisherId.
`ReferralInformation`	`referralCode(String referralCode)`	referralCode.
`ReferralInformation`	`referrerName(String referrerName)`	referrerName.
`ReferralInformation`	`saleDiscountAmount(String saleDiscountAmount)`	saleDiscountAmount.
`ReferralInformation`	`saleDiscountFixedAmount(String saleDiscountFixedAmount)`	saleDiscountFixedAmount.
`ReferralInformation`	`saleDiscountPercent(String saleDiscountPercent)`	saleDiscountPercent.
`ReferralInformation`	`saleDiscountPeriods(String saleDiscountPeriods)`	saleDiscountPeriods.
`ReferralInformation`	`saleDiscountSeatPriceOverride(String saleDiscountSeatPriceOverride)`	saleDiscountSeatPriceOverride.
`void`	`setAdvertisementId(String advertisementId)`	setAdvertisementId.
`void`	`setEnableSupport(String enableSupport)`	setEnableSupport.
`void`	`setExternalOrgId(String externalOrgId)`	setExternalOrgId.
`void`	`setGroupMemberId(String groupMemberId)`	setGroupMemberId.
`void`	`setIdType(String idType)`	setIdType.
`void`	`setIncludedSeats(String includedSeats)`	setIncludedSeats.
`void`	`setIndustry(String industry)`	setIndustry.
`void`	`setPlanStartMonth(String planStartMonth)`	setPlanStartMonth.
`void`	`setPromoCode(String promoCode)`	setPromoCode.
`void`	`setPublisherId(String publisherId)`	setPublisherId.
`void`	`setReferralCode(String referralCode)`	setReferralCode.
`void`	`setReferrerName(String referrerName)`	setReferrerName.
`void`	`setSaleDiscountAmount(String saleDiscountAmount)`	setSaleDiscountAmount.
`void`	`setSaleDiscountFixedAmount(String saleDiscountFixedAmount)`	setSaleDiscountFixedAmount.
`void`	`setSaleDiscountPercent(String saleDiscountPercent)`	setSaleDiscountPercent.
`void`	`setSaleDiscountPeriods(String saleDiscountPeriods)`	setSaleDiscountPeriods.
`void`	`setSaleDiscountSeatPriceOverride(String saleDiscountSeatPriceOverride)`	setSaleDiscountSeatPriceOverride.
`void`	`setShopperId(String shopperId)`	setShopperId.
`ReferralInformation`	`shopperId(String shopperId)`	shopperId.
`String`	`toString()`	Converts the given object to string.

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

- Constructor Detail
  - ReferralInformation
```
public ReferralInformation()
```
- Method Detail
  - advertisementId
```
public ReferralInformation advertisementId(String advertisementId)
```
    advertisementId.
    
    Returns:
    
    ReferralInformation
  - getAdvertisementId
```
public String getAdvertisementId()
```
    A complex type that contains the following information for entering referral and discount information. The following items are included in the referral information (all string content): enableSupport, includedSeats, saleDiscountPercent, saleDiscountAmount, saleDiscountFixedAmount, saleDiscountPeriods, saleDiscountSeatPriceOverride, planStartMonth, referralCode, referrerName, advertisementId, publisherId, shopperId, promoCode, groupMemberId, idType, and industry. ###### Note: saleDiscountPercent, saleDiscountAmount, saleDiscountFixedAmount, saleDiscountPeriods, and saleDiscountSeatPriceOverride are reserved for DoucSign use only. .
    
    Returns:
    
    advertisementId
  - setAdvertisementId
```
public void setAdvertisementId(String advertisementId)
```
    setAdvertisementId.
  - enableSupport
```
public ReferralInformation enableSupport(String enableSupport)
```
    enableSupport.
    
    Returns:
    
    ReferralInformation
  - getEnableSupport
```
public String getEnableSupport()
```
    When set to **true**, then customer support is provided as part of the account plan..
    
    Returns:
    
    enableSupport
  - setEnableSupport
```
public void setEnableSupport(String enableSupport)
```
    setEnableSupport.
  - externalOrgId
```
public ReferralInformation externalOrgId(String externalOrgId)
```
    externalOrgId.
    
    Returns:
    
    ReferralInformation
  - getExternalOrgId
```
public String getExternalOrgId()
```
    .
    
    Returns:
    
    externalOrgId
  - setExternalOrgId
```
public void setExternalOrgId(String externalOrgId)
```
    setExternalOrgId.
  - groupMemberId
```
public ReferralInformation groupMemberId(String groupMemberId)
```
    groupMemberId.
    
    Returns:
    
    ReferralInformation
  - getGroupMemberId
```
public String getGroupMemberId()
```
    .
    
    Returns:
    
    groupMemberId
  - setGroupMemberId
```
public void setGroupMemberId(String groupMemberId)
```
    setGroupMemberId.
  - idType
```
public ReferralInformation idType(String idType)
```
    idType.
    
    Returns:
    
    ReferralInformation
  - getIdType
```
public String getIdType()
```
    .
    
    Returns:
    
    idType
  - setIdType
```
public void setIdType(String idType)
```
    setIdType.
  - includedSeats
```
public ReferralInformation includedSeats(String includedSeats)
```
    includedSeats.
    
    Returns:
    
    ReferralInformation
  - getIncludedSeats
```
public String getIncludedSeats()
```
    The number of seats (users) included..
    
    Returns:
    
    includedSeats
  - setIncludedSeats
```
public void setIncludedSeats(String includedSeats)
```
    setIncludedSeats.
  - industry
```
public ReferralInformation industry(String industry)
```
    industry.
    
    Returns:
    
    ReferralInformation
  - getIndustry
```
public String getIndustry()
```
    .
    
    Returns:
    
    industry
  - setIndustry
```
public void setIndustry(String industry)
```
    setIndustry.
  - planStartMonth
```
public ReferralInformation planStartMonth(String planStartMonth)
```
    planStartMonth.
    
    Returns:
    
    ReferralInformation
  - getPlanStartMonth
```
public String getPlanStartMonth()
```
    .
    
    Returns:
    
    planStartMonth
  - setPlanStartMonth
```
public void setPlanStartMonth(String planStartMonth)
```
    setPlanStartMonth.
  - promoCode
```
public ReferralInformation promoCode(String promoCode)
```
    promoCode.
    
    Returns:
    
    ReferralInformation
  - getPromoCode
```
public String getPromoCode()
```
    .
    
    Returns:
    
    promoCode
  - setPromoCode
```
public void setPromoCode(String promoCode)
```
    setPromoCode.
  - publisherId
```
public ReferralInformation publisherId(String publisherId)
```
    publisherId.
    
    Returns:
    
    ReferralInformation
  - getPublisherId
```
public String getPublisherId()
```
    .
    
    Returns:
    
    publisherId
  - setPublisherId
```
public void setPublisherId(String publisherId)
```
    setPublisherId.
  - referralCode
```
public ReferralInformation referralCode(String referralCode)
```
    referralCode.
    
    Returns:
    
    ReferralInformation
  - getReferralCode
```
public String getReferralCode()
```
    .
    
    Returns:
    
    referralCode
  - setReferralCode
```
public void setReferralCode(String referralCode)
```
    setReferralCode.
  - referrerName
```
public ReferralInformation referrerName(String referrerName)
```
    referrerName.
    
    Returns:
    
    ReferralInformation
  - getReferrerName
```
public String getReferrerName()
```
    .
    
    Returns:
    
    referrerName
  - setReferrerName
```
public void setReferrerName(String referrerName)
```
    setReferrerName.
  - saleDiscountAmount
```
public ReferralInformation saleDiscountAmount(String saleDiscountAmount)
```
    saleDiscountAmount.
    
    Returns:
    
    ReferralInformation
  - getSaleDiscountAmount
```
public String getSaleDiscountAmount()
```
    Reserved for DocuSign use only..
    
    Returns:
    
    saleDiscountAmount
  - setSaleDiscountAmount
```
public void setSaleDiscountAmount(String saleDiscountAmount)
```
    setSaleDiscountAmount.
  - saleDiscountFixedAmount
```
public ReferralInformation saleDiscountFixedAmount(String saleDiscountFixedAmount)
```
    saleDiscountFixedAmount.
    
    Returns:
    
    ReferralInformation
  - getSaleDiscountFixedAmount
```
public String getSaleDiscountFixedAmount()
```
    Reserved for DocuSign use only..
    
    Returns:
    
    saleDiscountFixedAmount
  - setSaleDiscountFixedAmount
```
public void setSaleDiscountFixedAmount(String saleDiscountFixedAmount)
```
    setSaleDiscountFixedAmount.
  - saleDiscountPercent
```
public ReferralInformation saleDiscountPercent(String saleDiscountPercent)
```
    saleDiscountPercent.
    
    Returns:
    
    ReferralInformation
  - getSaleDiscountPercent
```
public String getSaleDiscountPercent()
```
    Reserved for DocuSign use only..
    
    Returns:
    
    saleDiscountPercent
  - setSaleDiscountPercent
```
public void setSaleDiscountPercent(String saleDiscountPercent)
```
    setSaleDiscountPercent.
  - saleDiscountPeriods
```
public ReferralInformation saleDiscountPeriods(String saleDiscountPeriods)
```
    saleDiscountPeriods.
    
    Returns:
    
    ReferralInformation
  - getSaleDiscountPeriods
```
public String getSaleDiscountPeriods()
```
    Reserved for DocuSign use only..
    
    Returns:
    
    saleDiscountPeriods
  - setSaleDiscountPeriods
```
public void setSaleDiscountPeriods(String saleDiscountPeriods)
```
    setSaleDiscountPeriods.
  - saleDiscountSeatPriceOverride
```
public ReferralInformation saleDiscountSeatPriceOverride(String saleDiscountSeatPriceOverride)
```
    saleDiscountSeatPriceOverride.
    
    Returns:
    
    ReferralInformation
  - getSaleDiscountSeatPriceOverride
```
public String getSaleDiscountSeatPriceOverride()
```
    Reserved for DocuSign use only..
    
    Returns:
    
    saleDiscountSeatPriceOverride
  - setSaleDiscountSeatPriceOverride
```
public void setSaleDiscountSeatPriceOverride(String saleDiscountSeatPriceOverride)
```
    setSaleDiscountSeatPriceOverride.
  - shopperId
```
public ReferralInformation shopperId(String shopperId)
```
    shopperId.
    
    Returns:
    
    ReferralInformation
  - getShopperId
```
public String getShopperId()
```
    .
    
    Returns:
    
    shopperId
  - setShopperId
```
public void setShopperId(String shopperId)
```
    setShopperId.
  - equals
```
public boolean equals(Object o)
```
    Compares objects.
    
    Overrides:
    
    equals in class Object
    
    Returns:
    
    true or false depending on comparison result.
  - hashCode
```
public int hashCode()
```
    Returns the HashCode.
    
    Overrides:
    
    hashCode in class Object
  - toString
```
public String toString()
```
    Converts the given object to string.
    
    Overrides:
    
    toString in class Object

Class ReferralInformation

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ReferralInformation

Method Detail

advertisementId

getAdvertisementId

setAdvertisementId

enableSupport

getEnableSupport

setEnableSupport

externalOrgId

getExternalOrgId

setExternalOrgId

groupMemberId

getGroupMemberId

setGroupMemberId

idType

getIdType

setIdType

includedSeats

getIncludedSeats

setIncludedSeats

industry

getIndustry

setIndustry

planStartMonth

getPlanStartMonth

setPlanStartMonth

promoCode

getPromoCode

setPromoCode

publisherId

getPublisherId

setPublisherId

referralCode

getReferralCode

setReferralCode

referrerName

getReferrerName

setReferrerName

saleDiscountAmount

getSaleDiscountAmount

setSaleDiscountAmount

saleDiscountFixedAmount

getSaleDiscountFixedAmount

setSaleDiscountFixedAmount

saleDiscountPercent

getSaleDiscountPercent

setSaleDiscountPercent

saleDiscountPeriods

getSaleDiscountPeriods

setSaleDiscountPeriods

saleDiscountSeatPriceOverride

getSaleDiscountSeatPriceOverride

setSaleDiscountSeatPriceOverride

shopperId

getShopperId

setShopperId

equals

hashCode

toString