com.ibm.commerce.order.facade.datatypes

Interface CouponCodeType

All Known Implementing Classes:

CouponCodeTypeImpl

public interface CouponCodeType

A representation of the model object 'Coupon Code Type'.

The following features are supported:

• Coupon Id
• Code
• Promotion Identifier
• Description
• Effective Date Time
• Expiration Date Time
• Status
• User Data

See Also:

OrderPackage.getCouponCodeType()

Method Summary

Modifier and Type	Method and Description
java.lang.String	getCode() Returns the value of the 'Code' attribute.
java.lang.String	getCouponId() Returns the value of the 'Coupon Id' attribute.
java.util.List	getDescription() Returns the value of the 'Description' containment reference list.
java.lang.Object	getEffectiveDateTime() Returns the value of the 'Effective Date Time' attribute.
java.lang.Object	getExpirationDateTime() Returns the value of the 'Expiration Date Time' attribute.
PromotionIdentifierType	getPromotionIdentifier() Returns the value of the 'Promotion Identifier' containment reference.
java.lang.String	getStatus() Returns the value of the 'Status' attribute.
UserDataType	getUserData() Returns the value of the 'User Data' containment reference.
void	setCode(java.lang.String value) Sets the value of the 'Code' attribute.
void	setCouponId(java.lang.String value) Sets the value of the 'Coupon Id' attribute.
void	setEffectiveDateTime(java.lang.Object value) Sets the value of the 'Effective Date Time' attribute.
void	setExpirationDateTime(java.lang.Object value) Sets the value of the 'Expiration Date Time' attribute.
void	setPromotionIdentifier(PromotionIdentifierType value) Sets the value of the 'Promotion Identifier' containment reference.
void	setStatus(java.lang.String value) Sets the value of the 'Status' attribute.
void	setUserData(UserDataType value) Sets the value of the 'User Data' containment reference.

Method Detail

getCouponId

java.lang.String getCouponId()

Returns the value of the 'Coupon Id' attribute.

If the meaning of the 'Coupon Id' attribute isn't clear, there really should be more of a description here...

Returns:

the value of the 'Coupon Id' attribute.

See Also:

setCouponId(String), OrderPackage.getCouponCodeType_CouponId()

setCouponId

void setCouponId(java.lang.String value)

Sets the value of the 'Coupon Id' attribute.

Parameters:

value - the new value of the 'Coupon Id' attribute.

See Also:

getCouponId()

getCode

java.lang.String getCode()

Returns the value of the 'Code' attribute. The code of coupon.

Returns:

the value of the 'Code' attribute.

See Also:

setCode(String), OrderPackage.getCouponCodeType_Code()

setCode

void setCode(java.lang.String value)

Sets the value of the 'Code' attribute.

Parameters:

value - the new value of the 'Code' attribute.

See Also:

getCode()

getPromotionIdentifier

PromotionIdentifierType getPromotionIdentifier()

Returns the value of the 'Promotion Identifier' containment reference. Identifier of the promotion that the coupon is for.

Returns:

the value of the 'Promotion Identifier' containment reference.

See Also:

setPromotionIdentifier(PromotionIdentifierType), OrderPackage.getCouponCodeType_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()

getDescription

java.util.List getDescription()

Returns the value of the 'Description' containment reference list. The list contents are of type CouponDescriptionType. Description of the coupon.

Returns:

the value of the 'Description' containment reference list.

See Also:

OrderPackage.getCouponCodeType_Description()

getEffectiveDateTime

java.lang.Object getEffectiveDateTime()

Returns the value of the 'Effective Date Time' attribute. Effective date and time of the coupon.

Returns:

the value of the 'Effective Date Time' attribute.

See Also:

setEffectiveDateTime(Object), OrderPackage.getCouponCodeType_EffectiveDateTime()

setEffectiveDateTime

void setEffectiveDateTime(java.lang.Object value)

Sets the value of the 'Effective Date Time' attribute.

Parameters:

value - the new value of the 'Effective Date Time' attribute.

See Also:

getEffectiveDateTime()

getExpirationDateTime

java.lang.Object getExpirationDateTime()

Returns the value of the 'Expiration Date Time' attribute. Expiration date and time of the coupon.

Returns:

the value of the 'Expiration Date Time' attribute.

See Also:

setExpirationDateTime(Object), OrderPackage.getCouponCodeType_ExpirationDateTime()

setExpirationDateTime

void setExpirationDateTime(java.lang.Object value)

Sets the value of the 'Expiration Date Time' attribute.

Parameters:

value - the new value of the 'Expiration Date Time' attribute.

See Also:

getExpirationDateTime()

getStatus

java.lang.String getStatus()

Returns the value of the 'Status' attribute. Status of the coupon.

Returns:

the value of the 'Status' attribute.

See Also:

setStatus(String), OrderPackage.getCouponCodeType_Status()

setStatus

void setStatus(java.lang.String value)

Sets the value of the 'Status' attribute.

Parameters:

value - the new value of the 'Status' attribute.

See Also:

getStatus()

getUserData

UserDataType getUserData()

Returns the value of the 'User Data' containment reference. The user data area.

Returns:

the value of the 'User Data' containment reference.

See Also:

setUserData(UserDataType), OrderPackage.getCouponCodeType_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()