atg.commerce.order

Interface ShippingGroupPropertyContainer

All Known Implementing Classes:

ElectronicShippingGroup, HardgoodShippingGroup, InStorePickupShippingGroup

public interface ShippingGroupPropertyContainer

By implementing this interface, the implementing class defines a list of shipping group properties to be used in the following operations.

Operations that use the shipping group property list are:

• copyProperties -- This method uses the property list to copy information from one shipping group to the other.
• doPropertiesMatch -- This method uses the property list to find a matching shipping group.
• arePropertiesEmpty -- This method uses the property list to find the emptiness of a shipping group.

See Also:

HardgoodShippingGroup, ElectronicShippingGroup

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CLASS_VERSION

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.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.

Field Detail

CLASS_VERSION

static final java.lang.String CLASS_VERSION

See Also:

Constant Field Values

Method Detail

doPropertiesMatch

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

Parameters:

pShippingGroupPropertyContainer - -- The object to be matched against

Returns:

if the properties matches returns true, otherwise false.

Throws:

CommerceException

copyProperties

void copyProperties(ShippingGroupPropertyContainer pSrcShippingGroupPropertyContainer)
             throws CommerceException

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.

Parameters:

pSrcShippingGroupPropertyContainer - -- The information to be copied from

Throws:

CommerceException

arePropertiesEmpty

boolean arePropertiesEmpty()
                    throws CommerceException

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.

Returns:

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

Throws:

CommerceException

getPropertyContainerPropertyNames

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

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

Returns:

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

initializePropertyContainerPropertyNames

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.

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.

Returns:

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