atg.commerce.order

Class InStorePickupShippingGroup

java.lang.Object

atg.commerce.order.CommerceIdentifierImpl

atg.commerce.order.ShippingGroupImpl

atg.commerce.order.InStorePickupShippingGroup

All Implemented Interfaces:

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

public class InStorePickupShippingGroup
extends ShippingGroupImpl
implements ShippingGroupPropertyContainer

A shipping group for items that will be picked up at a store location

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
InStorePickupShippingGroup()

Method Summary

Modifier and Type	Method and Description
boolean	arePropertiesEmpty() This method is used to check the emptiness of the current ShippingGroup instance.
void	copyProperties(ShippingGroupPropertyContainer pSrcShippingGroupPropertyContainer) This method is used to copy the information from the source ShippingGroup to the self destination.
boolean	doPropertiesMatch(ShippingGroupPropertyContainer pShippingGroupPropertyContainer) Do i match with the ShippingGroupPropertyContainer that is passed in?
java.lang.String	getFirstName() Get the first name of the person responsible for picking up the contents of this shipping group
java.lang.String	getLastName() Get the last name of the person responsible for picking up the contents of this shipping group
java.lang.String	getLocationId() Get the location where the items will be picked up from
java.lang.String	getMiddleName() Get the middle name of the person responsible for picking up the contents of this shipping group
java.util.List<java.lang.String>	getPropertyContainerPropertyNames() This method returns the list of properties that is used in the methods implemented using this interface.
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	setFirstName(java.lang.String pFirstName) Set the first name of the person responsible for picking up the contents of this shipping group
void	setLastName(java.lang.String pLastName) Set the last name of the person responsible for picking up the contents of this shipping group
void	setLocationId(java.lang.String pLocationId) Sets the location of this shipping group
void	setMiddleName(java.lang.String pMiddleName) Set the middle name of the person responsible for picking up the contents of this shipping group

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

InStorePickupShippingGroup

public InStorePickupShippingGroup()

Method Detail

getLocationId

public java.lang.String getLocationId()

Get the location where the items will be picked up from

Returns:

The location id as a String

setLocationId

public void setLocationId(java.lang.String pLocationId)

Sets the location of this shipping group

Parameters:

pLocationId - the location to set

getFirstName

public java.lang.String getFirstName()

Get the first name of the person responsible for picking up the contents of this shipping group

Returns:

The first name of the person responsible for picking up the contents of this shipping group

setFirstName

public void setFirstName(java.lang.String pFirstName)

Set the first name of the person responsible for picking up the contents of this shipping group

Parameters:

pFirstName - The first name to set.

getMiddleName

public java.lang.String getMiddleName()

Get the middle name of the person responsible for picking up the contents of this shipping group

Returns:

The middle name of the person responsible for picking up the contents of this shipping group

setMiddleName

public void setMiddleName(java.lang.String pMiddleName)

Set the middle name of the person responsible for picking up the contents of this shipping group

Parameters:

pMiddleName - The middle name to set

getLastName

public java.lang.String getLastName()

Get the last name of the person responsible for picking up the contents of this shipping group

Returns:

The last name of the person responsible for picking up the contents of this shipping group

setLastName

public void setLastName(java.lang.String pLastName)

Set the last name of the person responsible for picking up the contents of this shipping group

Parameters:

pLastName - The last name to set

getPropertyContainerPropertyNames

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

Description copied from interface: ShippingGroupPropertyContainer

This method returns the list of properties that is used in the methods implemented using this interface. These properties are used to find a match, copy information from source object to self and find emptiness of the object and emptiness of the shipping group

Specified by:

getPropertyContainerPropertyNames in interface ShippingGroupPropertyContainer

Returns:

list of properties which will be used to fulfill other functions mentioned in this interface.

initializePropertyContainerPropertyNames

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

Description copied from interface: ShippingGroupPropertyContainer

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.

This method should be used for the initializing the property names and most probably this method will be called only once per shipping group instance unless if someone wants to reinitialize .

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:

-- The initialized list of properties which will be used to fulfill other functions mentioned in this interface.

doPropertiesMatch

public boolean doPropertiesMatch(ShippingGroupPropertyContainer pShippingGroupPropertyContainer)
                          throws CommerceException

Description copied from interface: ShippingGroupPropertyContainer

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

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

copyProperties

public void copyProperties(ShippingGroupPropertyContainer pSrcShippingGroupPropertyContainer)
                    throws CommerceException

Description copied from interface: ShippingGroupPropertyContainer

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

This method uses propertyContainerPropertyNames property list to copy from source object to the self destination.

Specified by:

copyProperties in interface ShippingGroupPropertyContainer

Parameters:

pSrcShippingGroupPropertyContainer - -- The information to be copied from

Throws:

CommerceException

arePropertiesEmpty

public boolean arePropertiesEmpty()
                           throws CommerceException

Description copied from interface: ShippingGroupPropertyContainer

This method is used to check the emptiness of the current ShippingGroup instance. This method checks the emptiness for all properties from propertyContainerPropertyNames list. If any of the properties are not empty this returns false.

Specified by:

arePropertiesEmpty in interface ShippingGroupPropertyContainer

Returns:

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

Throws:

CommerceException