atg.commerce.fulfillment.processor
Class ProcHandleShippingGroupUpdateModification

java.lang.Object
  atg.commerce.fulfillment.processor.ProcHandleShippingGroupUpdateModification

All Implemented Interfaces:

PipelineProcessor

public class ProcHandleShippingGroupUpdateModification
extends java.lang.Object
implements PipelineProcessor

This processor executes the shipping group update modification sent in the modify order notification message to the OrderFulfiller. The message gets forwarded to the fulfiller system

Field Summary

static java.lang.String

CLASS_VERSION Class version string

Fields inherited from interface atg.service.pipeline.PipelineProcessor

STOP_CHAIN_EXECUTION, STOP_CHAIN_EXECUTION_AND_COMMIT, STOP_CHAIN_EXECUTION_AND_ROLLBACK

Constructor Summary

ProcHandleShippingGroupUpdateModification()

Method Summary

int[]	getRetCodes() Returns the valid return codes 1 - The processor completed
int	runProcess(java.lang.Object pParam, PipelineResult pResult) Processes the shipping group update modification.
protected void	setShippingGroupSubmittedDate(OrderFulfiller of, ShippingGroup pShippingGroup, java.util.List pModificationList) This method sets the submitted date of the shipping group to the current time.

Methods inherited from class java.lang.Object

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

Field Detail

CLASS_VERSION

public static java.lang.String CLASS_VERSION

Class version string

Constructor Detail

ProcHandleShippingGroupUpdateModification

public ProcHandleShippingGroupUpdateModification()

Method Detail

getRetCodes

public int[] getRetCodes()

Returns the valid return codes 1 - The processor completed

Specified by:

getRetCodes in interface PipelineProcessor

Returns:

an integer array of the valid return codes.

runProcess

public int runProcess(java.lang.Object pParam,
                      PipelineResult pResult)
               throws java.lang.Exception

Processes the shipping group update modification. Forwards the message to the fulfiller system. This method requires that an Order, CommerceMessage and OrderFulfiller object be supplied in pParam in a HashMap. Use the PipelineConstants class' static members to key the objects in the HashMap.

Specified by:

runProcess in interface PipelineProcessor

Parameters:

pParam - a HashMap which must contain a JMS message and OrderFulfiller object

pResult - a PipelineResult object which stores any information which must be returned from this method invokation

Returns:

an integer specifying the processor's return code

Throws:

java.lang.Exception - throws any exception back to the caller

See Also:

PipelineProcessor.runProcess(Object, PipelineResult)

setShippingGroupSubmittedDate

protected void setShippingGroupSubmittedDate(OrderFulfiller of,
                                             ShippingGroup pShippingGroup,
                                             java.util.List pModificationList)

This method sets the submitted date of the shipping group to the current time. To ensure this only happens once, it checks first to make sure it is not currently set.

Parameters:

pShippingGroup - The shipping group to set.

pModificationList - Place to store new modifications.