com.ibm.commerce.promotion.facade.datatypes

Interface PromotionElementType

public interface PromotionElementType

A representation of the model object 'Element Type'. Type definition of a promotion element.

The following features are supported:

• Element Name
• Element Type
• Element Sub Type
• Parent Element Name
• Element Sequence
• Element Variable
• User Data

See Also:

PromotionPackage.getPromotionElementType()

Method Summary

Modifier and Type	Method and Description
java.lang.String	getElementName() Returns the value of the 'Element Name' attribute.
double	getElementSequence() Returns the value of the 'Element Sequence' attribute.
java.lang.String	getElementSubType() Returns the value of the 'Element Sub Type' attribute.
java.lang.String	getElementType() Returns the value of the 'Element Type' attribute.
java.util.List	getElementVariable() Returns the value of the 'Element Variable' containment reference list.
java.lang.String	getParentElementName() Returns the value of the 'Parent Element Name' attribute.
UserDataType	getUserData() Returns the value of the 'User Data' containment reference.
boolean	isSetElementSequence() Returns whether the value of the 'Element Sequence' attribute is set.
void	setElementName(java.lang.String value) Sets the value of the 'Element Name' attribute.
void	setElementSequence(double value) Sets the value of the 'Element Sequence' attribute.
void	setElementSubType(java.lang.String value) Sets the value of the 'Element Sub Type' attribute.
void	setElementType(java.lang.String value) Sets the value of the 'Element Type' attribute.
void	setParentElementName(java.lang.String value) Sets the value of the 'Parent Element Name' attribute.
void	setUserData(UserDataType value) Sets the value of the 'User Data' containment reference.
void	unsetElementSequence() Unsets the value of the 'Element Sequence' attribute.

Method Detail

getElementName

java.lang.String getElementName()

Returns the value of the 'Element Name' attribute. Name of the promotion element. The name should be unique within the same promotion.

Returns:

the value of the 'Element Name' attribute.

See Also:

setElementName(String), PromotionPackage.getPromotionElementType_ElementName()

setElementName

void setElementName(java.lang.String value)

Sets the value of the 'Element Name' attribute.

Parameters:

value - the new value of the 'Element Name' attribute.

See Also:

getElementName()

getElementType

java.lang.String getElementType()

Returns the value of the 'Element Type' attribute. The registered element type to be used in promotion rule xml.

Returns:

the value of the 'Element Type' attribute.

See Also:

setElementType(String), PromotionPackage.getPromotionElementType_ElementType()

setElementType

void setElementType(java.lang.String value)

Sets the value of the 'Element Type' attribute.

Parameters:

value - the new value of the 'Element Type' attribute.

See Also:

getElementType()

getElementSubType

java.lang.String getElementSubType()

Returns the value of the 'Element Sub Type' attribute. Optional sub-type of an element type, it is used by user interface to manage the view of the element.

Returns:

the value of the 'Element Sub Type' attribute.

See Also:

setElementSubType(String), PromotionPackage.getPromotionElementType_ElementSubType()

setElementSubType

void setElementSubType(java.lang.String value)

Sets the value of the 'Element Sub Type' attribute.

Parameters:

value - the new value of the 'Element Sub Type' attribute.

See Also:

getElementSubType()

getParentElementName

java.lang.String getParentElementName()

Returns the value of the 'Parent Element Name' attribute. The name of the parent element.

Returns:

the value of the 'Parent Element Name' attribute.

See Also:

setParentElementName(String), PromotionPackage.getPromotionElementType_ParentElementName()

setParentElementName

void setParentElementName(java.lang.String value)

Sets the value of the 'Parent Element Name' attribute.

Parameters:

value - the new value of the 'Parent Element Name' attribute.

See Also:

getParentElementName()

getElementSequence

double getElementSequence()

Returns the value of the 'Element Sequence' attribute. The sequence number of this elelemt under the same parent element.

Returns:

the value of the 'Element Sequence' attribute.

See Also:

isSetElementSequence(), unsetElementSequence(), setElementSequence(double), PromotionPackage.getPromotionElementType_ElementSequence()

setElementSequence

void setElementSequence(double value)

Sets the value of the 'Element Sequence' attribute.

Parameters:

value - the new value of the 'Element Sequence' attribute.

See Also:

isSetElementSequence(), unsetElementSequence(), getElementSequence()

unsetElementSequence

void unsetElementSequence()

Unsets the value of the 'Element Sequence' attribute.

See Also:

isSetElementSequence(), getElementSequence(), setElementSequence(double)

isSetElementSequence

boolean isSetElementSequence()

Returns whether the value of the 'Element Sequence' attribute is set.

Returns:

whether the value of the 'Element Sequence' attribute is set.

See Also:

unsetElementSequence(), getElementSequence(), setElementSequence(double)

getElementVariable

java.util.List getElementVariable()

Returns the value of the 'Element Variable' containment reference list. The list contents are of type PromotionElementVariableType. Element variables that are associated with the element.

Returns:

the value of the 'Element Variable' containment reference list.

See Also:

PromotionPackage.getPromotionElementType_ElementVariable()

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.getPromotionElementType_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()