atg.commerce.order

Class HardgoodShippingGroup

java.lang.Object

atg.commerce.order.CommerceIdentifierImpl

atg.commerce.order.ShippingGroupImpl

atg.commerce.order.HardgoodShippingGroup

All Implemented Interfaces:

ChangedProperties, CommerceIdentifier, CommerceItemRelationshipContainer, CostCenterRelationshipContainer, HandlingInstructionContainer, PaymentGroupRelationshipContainer, ShippingAddressContainer, ShippingGroup, ShippingGroupPropertyContainer, java.io.Serializable, java.util.Observer

public class HardgoodShippingGroup
extends ShippingGroupImpl
implements ShippingAddressContainer, ShippingGroupPropertyContainer

This class is an implementation of a HargoodShippingGroup. It represents all the information which designates a shipment of a hardgood by a traditional carrier.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CLASS_VERSION Class version string

Fields inherited from class atg.commerce.order.ShippingGroupImpl

sResourceBundle

Constructor Summary

Constructors

Constructor and Description
HardgoodShippingGroup()

Method Summary

Modifier and Type	Method and Description
boolean	arePropertiesEmpty() This method is used to check the emptiness of the current shipping group instance.
void	copyProperties(ShippingGroupPropertyContainer pSrcShippingGroupPropertyContainer) This method is used to copy the information from the source shipping group to self destination.
boolean	doPropertiesMatch(ShippingGroupPropertyContainer pShippingGroupPropertyContainer) Do i match with the ShippingGroupPropertyContainer that is passed in?
java.util.List<java.lang.String>	getPropertyContainerPropertyNames() This method returns the list of properties.
Address	getShippingAddress() Returns the shippingAddress
java.lang.String	getTrackingNumber() Returns the trackingNumber
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	setShippingAddress(Address pShippingAddress) Sets the shippingAddress
void	setTrackingNumber(java.lang.String pTrackingNumber) Sets the trackingNumber

Methods inherited from class atg.commerce.order.ShippingGroupImpl

addChangedProperty, addCommerceItemRelationship, addCommerceItemRelationship, addCostCenterRelationship, addCostCenterRelationship, addHandlingInstruction, addHandlingInstruction, addPaymentGroupRelationship, addPaymentGroupRelationship, arePropertiesEmpty, clearChangedProperties, copyProperties, doPropertiesMatch, getActualShipDate, getChangedProperties, getCommerceItemRelationship, getCommerceItemRelationshipCount, getCommerceItemRelationships, getCostCenterRelationship, getCostCenterRelationshipCount, getCostCenterRelationships, getDescription, getHandlingInstruction, getHandlingInstructionCount, getHandlingInstructions, getPaymentGroupRelationship, getPaymentGroupRelationshipCount, getPaymentGroupRelationships, getPriceInfo, getPriceInfoRepositoryItem, getPropertyValue, getRepositoryItem, getSaveAllProperties, getShipOnDate, getShippingGroupClassType, getShippingMethod, getSpecialInstructions, getState, getStateAsString, getStateAsUserResource, getStateDetail, getSubmittedDate, isChanged, removeAllCommerceItemRelationships, removeAllCostCenterRelationships, removeAllHandlingInstructions, removeAllPaymentGroupRelationships, removeCommerceItemRelationship, removeCostCenterRelationship, 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

Constructor Detail

HardgoodShippingGroup

public HardgoodShippingGroup()

Method Detail

getTrackingNumber

public java.lang.String getTrackingNumber()

Returns the trackingNumber

setTrackingNumber

public void setTrackingNumber(java.lang.String pTrackingNumber)

Sets the trackingNumber

getShippingAddress

public Address getShippingAddress()

Returns the shippingAddress

Specified by:

getShippingAddress in interface ShippingAddressContainer

setShippingAddress

public void setShippingAddress(Address pShippingAddress)

Sets the shippingAddress

Specified by:

setShippingAddress in interface ShippingAddressContainer

getPropertyContainerPropertyNames

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

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

Specified by:

getPropertyContainerPropertyNames in interface ShippingGroupPropertyContainer

Returns:

list of property names

See Also:

initializePropertyContainerPropertyNames()

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.

If you want to include any additional properties, you need to extend this method to add any additional properties.

Specified by:

initializePropertyContainerPropertyNames in interface ShippingGroupPropertyContainer

Returns:

list of property names

copyProperties

public void copyProperties(ShippingGroupPropertyContainer pSrcShippingGroupPropertyContainer)
                    throws CommerceException

This method is used to copy the information from the source shipping group to self destination.

This method uses propertyContainerPropertyNames property list to copy from source shipping group to itself. Only the propertyContainerPropertyNames properties are copied.

Specified by:

copyProperties in interface ShippingGroupPropertyContainer

Parameters:

pSrcShippingGroupPropertyContainer - -- The information to be copied from

Throws:

CommerceException

See Also:

ShippingGroupImpl.copyProperties(ShippingGroup, java.util.Collection)

arePropertiesEmpty

public boolean arePropertiesEmpty()
                           throws CommerceException

This method is used to check the emptiness of the current shipping group instance. This method checks the emptiness for all properties from propertyContainerPropertyNames property list. If any of the properties are not empty this returns false, true otherwise.

Specified by:

arePropertiesEmpty in interface ShippingGroupPropertyContainer

Returns:

- if the object is empty returns true, false otherwise.

Throws:

CommerceException

See Also:

ShippingGroupImpl.arePropertiesEmpty(java.util.Collection)

doPropertiesMatch

public boolean doPropertiesMatch(ShippingGroupPropertyContainer pShippingGroupPropertyContainer)
                          throws CommerceException

Do i match with the ShippingGroupPropertyContainer that is passed in?

This method uses propertyContainerPropertyNames property list to find whether the shipping group matches with the current shipping group instance. If all the properties of shipping group parameter and current instance match, then the both instances are considered as match.

Specified by:

doPropertiesMatch in interface ShippingGroupPropertyContainer

Parameters:

pShippingGroupPropertyContainer - -- The object to be matched against

Returns:

if the properties matches returns true, otherwise false.

Throws:

CommerceException

See Also:

ShippingGroupImpl.doPropertiesMatch(ShippingGroup, List)