atg.commerce.fulfillment.processor

Class ProcSplitShippingGroupForAvailableItems

java.lang.Object

atg.commerce.fulfillment.processor.ProcSplitShippingGroupForAvailableItems

All Implemented Interfaces:

PipelineProcessor

public class ProcSplitShippingGroupForAvailableItems
extends java.lang.Object
implements PipelineProcessor

This processor splits the shipping group into two shipping groups, one with items PENDING_DELIVERY and one with items that aren't PENDING_DELIVERY

Field Summary

Fields

Modifier and Type	Field and Description
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

Constructors

Constructor and Description
ProcSplitShippingGroupForAvailableItems()

Method Summary

Modifier and Type	Method and Description
int[]	getRetCodes() Returns the valid return codes 1 - The processor completed
int	runProcess(java.lang.Object pParam, PipelineResult pResult) Split the shipping group into two shipping groups, one with items PENDING_DELIVERY and one with items that aren't PENDING_DELIVERY
protected java.util.List	splitShippingGroupWithAvailableItems(HardgoodFulfiller of, Order pOrder, ShippingGroup pShippingGroup, java.util.List pModificationList) Split the shipping group into two shipping groups, one with items PENDING_DELIVERY and one with items that aren't PENDING_DELIVERY

Methods inherited from class java.lang.Object

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

Field Detail

CLASS_VERSION

public static final java.lang.String CLASS_VERSION

Class version string

See Also:

Constant Field Values

Constructor Detail

ProcSplitShippingGroupForAvailableItems

public ProcSplitShippingGroupForAvailableItems()

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

Split the shipping group into two shipping groups, one with items PENDING_DELIVERY and one with items that aren't PENDING_DELIVERY

Specified by:

runProcess in interface PipelineProcessor

Parameters:

pParam - a HashMap which must contain an Order, ShippingGroup 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)

splitShippingGroupWithAvailableItems

protected java.util.List splitShippingGroupWithAvailableItems(HardgoodFulfiller of,
                                                              Order pOrder,
                                                              ShippingGroup pShippingGroup,
                                                              java.util.List pModificationList)
                                                       throws InvalidParameterException,
                                                              ObjectCreationException,
                                                              DuplicateShippingGroupException,
                                                              CommerceException

Split the shipping group into two shipping groups, one with items PENDING_DELIVERY and one with items that aren't PENDING_DELIVERY

Parameters:

pOrder - The order containing the shippingGroup

pShippingGroup - The shipping group to split

pModificationList - A place to store all new modifications

Returns:

A list of the newly created shipping groups.

Throws:

InvalidParameterException

atg.commerce.ObjectCreationException

DuplicateShippingGroupException

CommerceException

ObjectCreationException