com.ibm.commerce.marketing.promotion.runtime

Class TemplateKey

java.lang.Object

com.ibm.commerce.marketing.promotion.runtime.TemplateKey

All Implemented Interfaces:

Key, NumericKey, XMLizable, java.io.Serializable

public class TemplateKey
extends java.lang.Object
implements NumericKey, XMLizable

The class TemplateKey is used to identify a Template and contains object composition of storeKey, store name and its corresponding numeric key.

XML Snippet for TemplateKey:

  <TemplateKey>
                <StoreKey>
                        <DN>o=root organization</DN>
                        <Identifier>NullEntity</Identifier>
                </StoreKey>
                <Name>All Promotions</Name>
   </TemplateKey>
 

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	COPYRIGHT IBM Copyright

Constructor Summary

Constructors

Constructor and Description
TemplateKey() Constructor for TemplateKey.

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
void	fromXML(org.w3c.dom.Node anXMLNode) Transforms the XML node into its corresponding real Object.
java.lang.String	getName() Returns the name of template key.
java.lang.Number	getNumericKey() Returns the numeric key.
StoreKey	getStoreKey() Returns the storeKey associated with this template key.
int	hashCode()
boolean	isNumericKeySet() Checks to see if the numeric key is set or not.
void	setName(java.lang.String aName) Sets the name of template key.
void	setStoreKey(StoreKey aStoreKey) Sets the storeKey associated with this template key.
java.lang.String	toString() Give a String presentation of this Promotion Template Key.
java.lang.String	toXML() Converts the object into its corresponding XML format representation.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Field Detail

COPYRIGHT

public static final java.lang.String COPYRIGHT

IBM Copyright

See Also:

Constant Field Values

Constructor Detail

TemplateKey

public TemplateKey()

Constructor for TemplateKey.

Method Detail

isNumericKeySet

public boolean isNumericKeySet()

Description copied from interface: NumericKey

Checks to see if the numeric key is set or not.

Specified by:

isNumericKeySet in interface NumericKey

Returns:

true if the numeric key is set, false otherwise.

See Also:

NumericKey.isNumericKeySet()

getNumericKey

public java.lang.Number getNumericKey()

Description copied from interface: NumericKey

Returns the numeric key.

Specified by:

getNumericKey in interface NumericKey

Returns:

the numeric key.

See Also:

NumericKey.getNumericKey()

toXML

public java.lang.String toXML()
                       throws XMLizationException

Description copied from interface: XMLizable

Converts the object into its corresponding XML format representation.

Specified by:

toXML in interface XMLizable

Returns:

The string format of the XML that represents this XMLizable object

Throws:

XMLizationException - when this process fails

See Also:

XMLizable.toXML()

fromXML

public void fromXML(org.w3c.dom.Node anXMLNode)
             throws DeXMLizationException

Description copied from interface: XMLizable

Transforms the XML node into its corresponding real Object.

Specified by:

fromXML in interface XMLizable

Parameters:

anXMLNode - The node that represents an XMLizable object

Throws:

DeXMLizationException - when this process fails

See Also:

XMLizable.fromXML(Node)

getName

public java.lang.String getName()

Returns the name of template key.

Returns:

String the name of template key.

getStoreKey

public StoreKey getStoreKey()

Returns the storeKey associated with this template key.

Returns:

StoreKey associated with this template key.

setName

public void setName(java.lang.String aName)

Sets the name of template key.

Parameters:

aName - The name of template key to set.

setStoreKey

public void setStoreKey(StoreKey aStoreKey)

Sets the storeKey associated with this template key.

Parameters:

aStoreKey - The storeKey associated with this template key to set.

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

See Also:

Object.equals(Object)

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

See Also:

java.lang.Object.hasCode()

toString

public java.lang.String toString()

Give a String presentation of this Promotion Template Key.

Overrides:

toString in class java.lang.Object

Returns:

A String representation of the Promotion Template Key.