PromotionType

```
public interface PromotionType
```
A representation of the model object 'Type'. Type definition of a promotion noun.
The following features are supported:
See Also:

PromotionPackage.getPromotionType()

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`java.lang.String`	`getAdministrativeName()` Returns the value of the 'Administrative Name' attribute.
`java.lang.String`	`getComments()` Returns the value of the 'Comments' attribute.
`java.lang.String`	`getControlParameter()` Returns the value of the 'Control Parameter' attribute.
`CouponAttributeType`	`getCouponAttribute()` Returns the value of the 'Coupon Attribute' containment reference.
`java.util.List`	`getDescription()` Returns the value of the 'Description' containment reference list.
`java.util.List`	`getElement()` Returns the value of the 'Element' containment reference list.
`java.lang.Object`	`getExclusiveType()` Returns the value of the 'Exclusive Type' attribute.
`int`	`getPriority()` Returns the value of the 'Priority' attribute.
`java.util.List`	`getPromotionCode()` Returns the value of the 'Promotion Code' attribute list.
`com.ibm.commerce.promotion.facade.datatypes.PromotionCodeSpecificationType`	`getPromotionCodeSpecification()` Returns the value of the 'Promotion Code Specification' containment reference.
`PromotionIdentifierType`	`getPromotionIdentifier()` Returns the value of the 'Promotion Identifier' containment reference.
`java.lang.String`	`getPromotionType()` Returns the value of the 'Promotion Type' attribute.
`PromotionRedemptionLimitType`	`getRedemptionLimit()` Returns the value of the 'Redemption Limit' containment reference.
`PromotionScheduleType`	`getSchedule()` Returns the value of the 'Schedule' containment reference.
`java.lang.Object`	`getStatus()` Returns the value of the 'Status' attribute.
`MonetaryAmountType`	`getTargetSales()` Returns the value of the 'Target Sales' containment reference.
`UserDataType`	`getUserData()` Returns the value of the 'User Data' containment reference.
`boolean`	`isCouponRequired()` Returns the value of the 'Coupon Required' attribute.
`boolean`	`isPromotionCodeRequired()` Returns the value of the 'Promotion Code Required' attribute.
`boolean`	`isSetCouponRequired()` Returns whether the value of the '`Coupon Required`' attribute is set.
`boolean`	`isSetPriority()` Returns whether the value of the '`Priority`' attribute is set.
`boolean`	`isSetPromotionCodeRequired()` Returns whether the value of the '`Promotion Code Required`' attribute is set.
`void`	`setAdministrativeName(java.lang.String value)` Sets the value of the '`Administrative Name`' attribute.
`void`	`setComments(java.lang.String value)` Sets the value of the '`Comments`' attribute.
`void`	`setControlParameter(java.lang.String value)` Sets the value of the '`Control Parameter`' attribute.
`void`	`setCouponAttribute(CouponAttributeType value)` Sets the value of the '`Coupon Attribute`' containment reference.
`void`	`setCouponRequired(boolean value)` Sets the value of the '`Coupon Required`' attribute.
`void`	`setExclusiveType(java.lang.Object value)` Sets the value of the '`Exclusive Type`' attribute.
`void`	`setPriority(int value)` Sets the value of the '`Priority`' attribute.
`void`	`setPromotionCodeRequired(boolean value)` Sets the value of the '`Promotion Code Required`' attribute.
`void`	`setPromotionCodeSpecification(com.ibm.commerce.promotion.facade.datatypes.PromotionCodeSpecificationType value)` Sets the value of the '`Promotion Code Specification`' containment reference.
`void`	`setPromotionIdentifier(PromotionIdentifierType value)` Sets the value of the '`Promotion Identifier`' containment reference.
`void`	`setPromotionType(java.lang.String value)` Sets the value of the '`Promotion Type`' attribute.
`void`	`setRedemptionLimit(PromotionRedemptionLimitType value)` Sets the value of the '`Redemption Limit`' containment reference.
`void`	`setSchedule(PromotionScheduleType value)` Sets the value of the '`Schedule`' containment reference.
`void`	`setStatus(java.lang.Object value)` Sets the value of the '`Status`' attribute.
`void`	`setTargetSales(MonetaryAmountType value)` Sets the value of the '`Target Sales`' containment reference.
`void`	`setUserData(UserDataType value)` Sets the value of the '`User Data`' containment reference.
`void`	`unsetCouponRequired()` Unsets the value of the '`Coupon Required`' attribute.
`void`	`unsetPriority()` Unsets the value of the '`Priority`' attribute.
`void`	`unsetPromotionCodeRequired()` Unsets the value of the '`Promotion Code Required`' attribute.

- Method Detail
  - getPromotionIdentifier
```
PromotionIdentifierType getPromotionIdentifier()
```
    Returns the value of the 'Promotion Identifier' containment reference. Promotion identifier.
    
    Returns:
    
    the value of the 'Promotion Identifier' containment reference.
    
    See Also:
    
    setPromotionIdentifier(PromotionIdentifierType), PromotionPackage.getPromotionType_PromotionIdentifier()
  - setPromotionIdentifier
```
void setPromotionIdentifier(PromotionIdentifierType value)
```
    Sets the value of the 'Promotion Identifier' containment reference.
    
    Parameters:
    
    value - the new value of the 'Promotion Identifier' containment reference.
    
    See Also:
    
    getPromotionIdentifier()
  - getPromotionType
```
java.lang.String getPromotionType()
```
    Returns the value of the 'Promotion Type' attribute. The registered promotion rule type which indicates the actual implementation of the runtime promotion object as well as general rule conditions, for example "OrderLevelPercentDiscount".
    
    Returns:
    
    the value of the 'Promotion Type' attribute.
    
    See Also:
    
    setPromotionType(String), PromotionPackage.getPromotionType_PromotionType()
  - setPromotionType
```
void setPromotionType(java.lang.String value)
```
    Sets the value of the 'Promotion Type' attribute.
    
    Parameters:
    
    value - the new value of the 'Promotion Type' attribute.
    
    See Also:
    
    getPromotionType()
  - getStatus
```
java.lang.Object getStatus()
```
    Returns the value of the 'Status' attribute. Promotion status.
    
    Returns:
    
    the value of the 'Status' attribute.
    
    See Also:
    
    setStatus(Object), PromotionPackage.getPromotionType_Status()
  - setStatus
```
void setStatus(java.lang.Object value)
```
    Sets the value of the 'Status' attribute.
    
    Parameters:
    
    value - the new value of the 'Status' attribute.
    
    See Also:
    
    getStatus()
  - getPriority
```
int getPriority()
```
    Returns the value of the 'Priority' attribute. Priority of the promotion.
    
    Returns:
    
    the value of the 'Priority' attribute.
    
    See Also:
    
    isSetPriority(), unsetPriority(), setPriority(int), PromotionPackage.getPromotionType_Priority()
  - setPriority
```
void setPriority(int value)
```
    Sets the value of the 'Priority' attribute.
    
    Parameters:
    
    value - the new value of the 'Priority' attribute.
    
    See Also:
    
    isSetPriority(), unsetPriority(), getPriority()
  - unsetPriority
```
void unsetPriority()
```
    Unsets the value of the 'Priority' attribute.
    
    See Also:
    
    isSetPriority(), getPriority(), setPriority(int)
  - isSetPriority
```
boolean isSetPriority()
```
    Returns whether the value of the 'Priority' attribute is set.
    
    Returns:
    
    whether the value of the 'Priority' attribute is set.
    
    See Also:
    
    unsetPriority(), getPriority(), setPriority(int)
  - getExclusiveType
```
java.lang.Object getExclusiveType()
```
    Returns the value of the 'Exclusive Type' attribute. Flag indicates the promotion exclusiveness.
    
    Returns:
    
    the value of the 'Exclusive Type' attribute.
    
    See Also:
    
    setExclusiveType(Object), PromotionPackage.getPromotionType_ExclusiveType()
  - setExclusiveType
```
void setExclusiveType(java.lang.Object value)
```
    Sets the value of the 'Exclusive Type' attribute.
    
    Parameters:
    
    value - the new value of the 'Exclusive Type' attribute.
    
    See Also:
    
    getExclusiveType()
  - getAdministrativeName
```
java.lang.String getAdministrativeName()
```
    Returns the value of the 'Administrative Name' attribute. Administrative name of the promotion which is displayed in the user interface.
    
    Returns:
    
    the value of the 'Administrative Name' attribute.
    
    See Also:
    
    setAdministrativeName(String), PromotionPackage.getPromotionType_AdministrativeName()
  - setAdministrativeName
```
void setAdministrativeName(java.lang.String value)
```
    Sets the value of the 'Administrative Name' attribute.
    
    Parameters:
    
    value - the new value of the 'Administrative Name' attribute.
    
    See Also:
    
    getAdministrativeName()
  - getComments
```
java.lang.String getComments()
```
    Returns the value of the 'Comments' attribute. Optional comments of the promotion.
    
    Returns:
    
    the value of the 'Comments' attribute.
    
    See Also:
    
    setComments(String), PromotionPackage.getPromotionType_Comments()
  - setComments
```
void setComments(java.lang.String value)
```
    Sets the value of the 'Comments' attribute.
    
    Parameters:
    
    value - the new value of the 'Comments' attribute.
    
    See Also:
    
    getComments()
  - getSchedule
```
PromotionScheduleType getSchedule()
```
    Returns the value of the 'Schedule' containment reference. Promotion schedule information.
    
    Returns:
    
    the value of the 'Schedule' containment reference.
    
    See Also:
    
    setSchedule(PromotionScheduleType), PromotionPackage.getPromotionType_Schedule()
  - setSchedule
```
void setSchedule(PromotionScheduleType value)
```
    Sets the value of the 'Schedule' containment reference.
    
    Parameters:
    
    value - the new value of the 'Schedule' containment reference.
    
    See Also:
    
    getSchedule()
  - getRedemptionLimit
```
PromotionRedemptionLimitType getRedemptionLimit()
```
    Returns the value of the 'Redemption Limit' containment reference. Promotion redemption limit inoformation.
    
    Returns:
    
    the value of the 'Redemption Limit' containment reference.
    
    See Also:
    
    setRedemptionLimit(PromotionRedemptionLimitType), PromotionPackage.getPromotionType_RedemptionLimit()
  - setRedemptionLimit
```
void setRedemptionLimit(PromotionRedemptionLimitType value)
```
    Sets the value of the 'Redemption Limit' containment reference.
    
    Parameters:
    
    value - the new value of the 'Redemption Limit' containment reference.
    
    See Also:
    
    getRedemptionLimit()
  - getDescription
```
java.util.List getDescription()
```
    Returns the value of the 'Description' containment reference list. The list contents are of type DescriptionType. The language specific descriptions of the promotion.
    
    Returns:
    
    the value of the 'Description' containment reference list.
    
    See Also:
    
    PromotionPackage.getPromotionType_Description()
  - isCouponRequired
```
boolean isCouponRequired()
```
    Returns the value of the 'Coupon Required' attribute. Whether a coupon is required for redeem this promotion.
    
    Returns:
    
    the value of the 'Coupon Required' attribute.
    
    See Also:
    
    isSetCouponRequired(), unsetCouponRequired(), setCouponRequired(boolean), PromotionPackage.getPromotionType_CouponRequired()
  - setCouponRequired
```
void setCouponRequired(boolean value)
```
    Sets the value of the 'Coupon Required' attribute.
    
    Parameters:
    
    value - the new value of the 'Coupon Required' attribute.
    
    See Also:
    
    isSetCouponRequired(), unsetCouponRequired(), isCouponRequired()
  - unsetCouponRequired
```
void unsetCouponRequired()
```
    Unsets the value of the 'Coupon Required' attribute.
    
    See Also:
    
    isSetCouponRequired(), isCouponRequired(), setCouponRequired(boolean)
  - isSetCouponRequired
```
boolean isSetCouponRequired()
```
    Returns whether the value of the 'Coupon Required' attribute is set.
    
    Returns:
    
    whether the value of the 'Coupon Required' attribute is set.
    
    See Also:
    
    unsetCouponRequired(), isCouponRequired(), setCouponRequired(boolean)
  - getCouponAttribute
```
CouponAttributeType getCouponAttribute()
```
    Returns the value of the 'Coupon Attribute' containment reference. Informaiton of coupon attributes.
    
    Returns:
    
    the value of the 'Coupon Attribute' containment reference.
    
    See Also:
    
    setCouponAttribute(CouponAttributeType), PromotionPackage.getPromotionType_CouponAttribute()
  - setCouponAttribute
```
void setCouponAttribute(CouponAttributeType value)
```
    Sets the value of the 'Coupon Attribute' containment reference.
    
    Parameters:
    
    value - the new value of the 'Coupon Attribute' containment reference.
    
    See Also:
    
    getCouponAttribute()
  - isPromotionCodeRequired
```
boolean isPromotionCodeRequired()
```
    Returns the value of the 'Promotion Code Required' attribute. Indicate whether a promotion code is required to redeem this promotion.
    
    Returns:
    
    the value of the 'Promotion Code Required' attribute.
    
    See Also:
    
    isSetPromotionCodeRequired(), unsetPromotionCodeRequired(), setPromotionCodeRequired(boolean), PromotionPackage.getPromotionType_PromotionCodeRequired()
  - setPromotionCodeRequired
```
void setPromotionCodeRequired(boolean value)
```
    Sets the value of the 'Promotion Code Required' attribute.
    
    Parameters:
    
    value - the new value of the 'Promotion Code Required' attribute.
    
    See Also:
    
    isSetPromotionCodeRequired(), unsetPromotionCodeRequired(), isPromotionCodeRequired()
  - unsetPromotionCodeRequired
```
void unsetPromotionCodeRequired()
```
    Unsets the value of the 'Promotion Code Required' attribute.
    
    See Also:
    
    isSetPromotionCodeRequired(), isPromotionCodeRequired(), setPromotionCodeRequired(boolean)
  - isSetPromotionCodeRequired
```
boolean isSetPromotionCodeRequired()
```
    Returns whether the value of the 'Promotion Code Required' attribute is set.
    
    Returns:
    
    whether the value of the 'Promotion Code Required' attribute is set.
    
    See Also:
    
    unsetPromotionCodeRequired(), isPromotionCodeRequired(), setPromotionCodeRequired(boolean)
  - getPromotionCode
```
java.util.List getPromotionCode()
```
    Returns the value of the 'Promotion Code' attribute list. The list contents are of type String. Optional promotion codes associated with this promotion if the promotion code is required.
    
    Returns:
    
    the value of the 'Promotion Code' attribute list.
    
    See Also:
    
    PromotionPackage.getPromotionType_PromotionCode()
  - getTargetSales
```
MonetaryAmountType getTargetSales()
```
    Returns the value of the 'Target Sales' containment reference. Optional target sales amount for reporting purpose.
    
    Returns:
    
    the value of the 'Target Sales' containment reference.
    
    See Also:
    
    setTargetSales(MonetaryAmountType), PromotionPackage.getPromotionType_TargetSales()
  - setTargetSales
```
void setTargetSales(MonetaryAmountType value)
```
    Sets the value of the 'Target Sales' containment reference.
    
    Parameters:
    
    value - the new value of the 'Target Sales' containment reference.
    
    See Also:
    
    getTargetSales()
  - getElement
```
java.util.List getElement()
```
    Returns the value of the 'Element' containment reference list. The list contents are of type PromotionElementType. Promotion elements information associate with the FlowXML that are managed by a LOB tool and used for generating the actual promotion rule XML.
    
    Returns:
    
    the value of the 'Element' containment reference list.
    
    See Also:
    
    PromotionPackage.getPromotionType_Element()
  - getControlParameter
```
java.lang.String getControlParameter()
```
    Returns the value of the 'Control Parameter' attribute. Optional control parameter that is used by promotion authoring user interface.
    
    Returns:
    
    the value of the 'Control Parameter' attribute.
    
    See Also:
    
    setControlParameter(String), PromotionPackage.getPromotionType_ControlParameter()
  - setControlParameter
```
void setControlParameter(java.lang.String value)
```
    Sets the value of the 'Control Parameter' attribute.
    
    Parameters:
    
    value - the new value of the 'Control Parameter' attribute.
    
    See Also:
    
    getControlParameter()
  - getPromotionCodeSpecification
```
com.ibm.commerce.promotion.facade.datatypes.PromotionCodeSpecificationType getPromotionCodeSpecification()
```
    Returns the value of the 'Promotion Code Specification' containment reference. Optional promotion code specification element to include details on promotion codes.
    
    Returns:
    
    the value of the 'Promotion Code Specification' containment reference.
    
    See Also:
    
    setPromotionCodeSpecification(PromotionCodeSpecificationType), PromotionPackage.getPromotionType_PromotionCodeSpecification()
  - setPromotionCodeSpecification
```
void setPromotionCodeSpecification(com.ibm.commerce.promotion.facade.datatypes.PromotionCodeSpecificationType value)
```
    Sets the value of the 'Promotion Code Specification' containment reference.
    
    Parameters:
    
    value - the new value of the 'Promotion Code Specification' containment reference.
    
    See Also:
    
    getPromotionCodeSpecification()
  - getUserData
```
UserDataType getUserData()
```
    Returns the value of the 'User Data' containment reference. User data area.
    
    Returns:
    
    the value of the 'User Data' containment reference.
    
    See Also:
    
    setUserData(UserDataType), PromotionPackage.getPromotionType_UserData()
  - setUserData
```
void setUserData(UserDataType value)
```
    Sets the value of the 'User Data' containment reference.
    
    Parameters:
    
    value - the new value of the 'User Data' containment reference.
    
    See Also:
    
    getUserData()

getPromotionIdentifier

setPromotionIdentifier

getPromotionType

setPromotionType

getStatus

setStatus

getPriority

setPriority

unsetPriority

isSetPriority

getExclusiveType

setExclusiveType

getAdministrativeName

setAdministrativeName

getComments

setComments

getSchedule

setSchedule

getRedemptionLimit

setRedemptionLimit

getDescription

isCouponRequired

setCouponRequired

unsetCouponRequired

isSetCouponRequired

getCouponAttribute

setCouponAttribute

isPromotionCodeRequired

setPromotionCodeRequired

unsetPromotionCodeRequired

isSetPromotionCodeRequired

getPromotionCode

getTargetSales

setTargetSales

getElement

getControlParameter

setControlParameter

getPromotionCodeSpecification

setPromotionCodeSpecification

getUserData

setUserData