atg.projects.store.order
Class StoreElectronicShippingGroup

java.lang.Object
  atg.commerce.order.CommerceIdentifierImpl
      atg.commerce.order.ShippingGroupImpl
          atg.commerce.order.ElectronicShippingGroup
              atg.projects.store.order.StoreElectronicShippingGroup

All Implemented Interfaces:

atg.commerce.order.ChangedProperties, atg.commerce.order.CommerceIdentifier, atg.commerce.order.CommerceItemRelationshipContainer, atg.commerce.order.EmailAddressContainer, atg.commerce.order.HandlingInstructionContainer, atg.commerce.order.PaymentGroupRelationshipContainer, atg.commerce.order.ShippingGroup, atg.commerce.order.ShippingGroupPropertyContainer, java.io.Serializable, java.util.Observer

public class StoreElectronicShippingGroup
extends atg.commerce.order.ElectronicShippingGroup

This class extends ElectronicShippingGroup to add a few properties.

See Also:

Serialized Form

Field Summary

static java.lang.String	CLASS_VERSION Class version string.
static java.lang.String	PROPERTY_FROM_EMAIL_ADDRESS From e-mail address property name.
static java.lang.String	PROPERTY_FROM_NAME From name property name.
static java.lang.String	PROPERTY_MESSAGE Message property name.
static java.lang.String	PROPERTY_SUBJECT Subject property name.
static java.lang.String	PROPERTY_TO_NAME To name property name.

Fields inherited from class atg.commerce.order.ShippingGroupImpl

sResourceBundle

Constructor Summary

StoreElectronicShippingGroup()
Creates a new StoreElectronicShippingGroup object.

Method Summary

boolean	doPropertiesMatch(atg.commerce.order.ShippingGroupPropertyContainer pShippingGroupPropertyContainer) Do i match with the ShippingGroupPropertyContainer that is passed in? This method uses getPropertyContainerPropertyNames() property list to find whether the shipping group matches with the current shipping group instance
java.lang.String	getFromEmailAddress()
java.lang.String	getFromName()
java.lang.String	getMessage()
java.util.Map	getProperties()
java.lang.String	getSubject()
java.lang.String	getToName()
java.util.List<java.lang.String>	initializePropertyContainerPropertyNames() This method initializes the properties which are used to find a match, copy information from source shipping group to self and find emptiness of the shipping group.
void	setFromEmailAddress(java.lang.String pFromEmailAddress) Sets the from e-mail address.
void	setFromName(java.lang.String pFromName) Sets the from name.
void	setMessage(java.lang.String pMessage) Sets the message.
void	setProperties(java.util.Map pProperties) Sets all the properties at once.
void	setSubject(java.lang.String pSubject) Sets the subject.
void	setToName(java.lang.String pToName) Sets the to name property.

Methods inherited from class atg.commerce.order.ElectronicShippingGroup

arePropertiesEmpty, copyProperties, getEmailAddress, getPropertyContainerPropertyNames, setEmailAddress

Methods inherited from class atg.commerce.order.ShippingGroupImpl

addChangedProperty, addCommerceItemRelationship, addCommerceItemRelationship, addHandlingInstruction, addHandlingInstruction, addPaymentGroupRelationship, addPaymentGroupRelationship, arePropertiesEmpty, clearChangedProperties, copyProperties, doPropertiesMatch, getActualShipDate, getChangedProperties, getCommerceItemRelationship, getCommerceItemRelationshipCount, getCommerceItemRelationships, getDescription, getHandlingInstruction, getHandlingInstructionCount, getHandlingInstructions, getPaymentGroupRelationship, getPaymentGroupRelationshipCount, getPaymentGroupRelationships, getPriceInfo, getPriceInfoRepositoryItem, getPropertyValue, getRepositoryItem, getSaveAllProperties, getShipOnDate, getShippingGroupClassType, getShippingMethod, getSpecialInstructions, getState, getStateAsString, getStateAsUserResource, getStateDetail, getSubmittedDate, isChanged, removeAllCommerceItemRelationships, removeAllHandlingInstructions, removeAllPaymentGroupRelationships, removeCommerceItemRelationship, removeHandlingInstruction, removePaymentGroupRelationship, setActualShipDate, setChanged, setDescription, setPriceInfo, setPriceInfoRepositoryItem, setPropertyValue, setRepositoryItem, setSaveAllProperties, setShipOnDate, setShippingGroupClassType, setShippingMethod, setSpecialInstructions, setState, setStateAsString, setStateDetail, setSubmittedDate, toString, update

Methods inherited from class atg.commerce.order.CommerceIdentifierImpl

getId, setId

Methods inherited from class java.lang.Object

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

Methods inherited from interface atg.commerce.order.CommerceIdentifier

getId

Field Detail

CLASS_VERSION

public static java.lang.String CLASS_VERSION

Class version string.

PROPERTY_FROM_EMAIL_ADDRESS

public static final java.lang.String PROPERTY_FROM_EMAIL_ADDRESS

From e-mail address property name.

See Also:

Constant Field Values

PROPERTY_FROM_NAME

public static final java.lang.String PROPERTY_FROM_NAME

From name property name.

See Also:

Constant Field Values

PROPERTY_MESSAGE

public static final java.lang.String PROPERTY_MESSAGE

Message property name.

See Also:

Constant Field Values

PROPERTY_SUBJECT

public static final java.lang.String PROPERTY_SUBJECT

Subject property name.

See Also:

Constant Field Values

PROPERTY_TO_NAME

public static final java.lang.String PROPERTY_TO_NAME

To name property name.

See Also:

Constant Field Values

Constructor Detail

StoreElectronicShippingGroup

public StoreElectronicShippingGroup()

Creates a new StoreElectronicShippingGroup object.

Method Detail

getFromEmailAddress

public java.lang.String getFromEmailAddress()

Returns:

the from e-mail address.

setFromEmailAddress

public void setFromEmailAddress(java.lang.String pFromEmailAddress)

Sets the from e-mail address.

Parameters:

pFromEmailAddress - - from e-mail address.

getFromName

public java.lang.String getFromName()

Returns:

the from name property.

setFromName

public void setFromName(java.lang.String pFromName)

Sets the from name.

Parameters:

pFromName - - from name

getMessage

public java.lang.String getMessage()

Returns:

the message.

setMessage

public void setMessage(java.lang.String pMessage)

Sets the message.

Parameters:

pMessage - - the message

getSubject

public java.lang.String getSubject()

Returns:

the subject.

setSubject

public void setSubject(java.lang.String pSubject)

Sets the subject.

Parameters:

pSubject - - the subject

getToName

public java.lang.String getToName()

Returns:

the to name property value.

setToName

public void setToName(java.lang.String pToName)

Sets the to name property.

Parameters:

pToName - - to name property

getProperties

public java.util.Map getProperties()

Returns:

all the properties of this shipping group in a map.

setProperties

public void setProperties(java.util.Map pProperties)

Sets all the properties at once.

Parameters:

pProperties - - properties map

initializePropertyContainerPropertyNames

public java.util.List<java.lang.String> initializePropertyContainerPropertyNames()

This method initializes the properties which are used to find a match, copy information from source shipping group to self and find emptiness of the shipping group.

Specified by:

initializePropertyContainerPropertyNames in interface atg.commerce.order.ShippingGroupPropertyContainer

Overrides:

initializePropertyContainerPropertyNames in class atg.commerce.order.ElectronicShippingGroup

Returns:

list of property names

doPropertiesMatch

public boolean doPropertiesMatch(atg.commerce.order.ShippingGroupPropertyContainer pShippingGroupPropertyContainer)
                          throws atg.commerce.CommerceException

Do i match with the ShippingGroupPropertyContainer that is passed in? This method uses getPropertyContainerPropertyNames() property list to find whether the shipping group matches with the current shipping group instance

Specified by:

doPropertiesMatch in interface atg.commerce.order.ShippingGroupPropertyContainer

Overrides:

doPropertiesMatch in class atg.commerce.order.ElectronicShippingGroup

Parameters:

pShippingGroupPropertyContainer - -- The object to be matched against

Returns:

if the properties matches returns true, otherwise false.

Throws:

atg.commerce.CommerceException