atg.commerce.promotion
Class PromotionConverter

java.lang.Object
  atg.scenario.xref.converter.ReferenceTargetConverterImpl
      atg.commerce.promotion.PromotionConverter

All Implemented Interfaces:

atg.scenario.xref.converter.ReferenceTargetConverter, java.io.Serializable

public class PromotionConverter
extends atg.scenario.xref.converter.ReferenceTargetConverterImpl

Converts promotion id's into promotion names for Xref items

See Also:

Serialized Form

Field Summary

static java.lang.String	CLASS_VERSION Class version string
static java.lang.String	PROMOTION_TOOLS_PATH Component path for promotion tools

Constructor Summary

PromotionConverter()

PromotionConverter(java.lang.String pReferenceType)
Constructs an instanceof PromotionConverter

Method Summary

java.lang.Object

getXrefItemValue(java.lang.String pString) Takes a given promotion id and returns the name of the promotion

Methods inherited from class atg.scenario.xref.converter.ReferenceTargetConverterImpl

getReferenceType, setReferenceType

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

CLASS_VERSION

public static java.lang.String CLASS_VERSION

Class version string

PROMOTION_TOOLS_PATH

public static final java.lang.String PROMOTION_TOOLS_PATH

Component path for promotion tools

See Also:

Constant Field Values

Constructor Detail

PromotionConverter

public PromotionConverter()

PromotionConverter

public PromotionConverter(java.lang.String pReferenceType)

Constructs an instanceof PromotionConverter

Parameters:

pReferenceType - the reference type that this converter converts values for

Method Detail

getXrefItemValue

public java.lang.Object getXrefItemValue(java.lang.String pString)
                                  throws ScenarioException

Takes a given promotion id and returns the name of the promotion

Specified by:

getXrefItemValue in interface atg.scenario.xref.converter.ReferenceTargetConverter

Specified by:

getXrefItemValue in class atg.scenario.xref.converter.ReferenceTargetConverterImpl

Parameters:

pString - the promotion id

Returns:

the name of the promotion, or null if the passed in id does not refer to a promotion

Throws:

ScenarioException - if null is passed in or a RepositoryException occurs