atg.commerce.fulfillment.processor

Class ProcRemoveShipItemRelsFromShippingGroup

java.lang.Object

atg.commerce.fulfillment.processor.ProcRemoveShipItemRelsFromShippingGroup

All Implemented Interfaces:

PipelineProcessor

public class ProcRemoveShipItemRelsFromShippingGroup
extends java.lang.Object
implements PipelineProcessor

This processor removes item Relationships from the shipping group. It will call to the corresponding chain that removes each itemRel from the group.

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

Method Summary

Modifier and Type	Method and Description
java.lang.String	getChainToRun()
int[]	getRetCodes() Returns the valid return codes 1 - The processor completed
protected boolean	removeShippingGroupItemRelationship(HardgoodFulfiller of, Order pOrder, ShippingGroupCommerceItemRelationship pShippingGroupItemRelationship, Modification pModification, java.util.List pPerformedModifications) Deprecated. use the version of this method that takes a ShippingGroupCommerceItemRelationship and an Object as the only two arguments
protected boolean	removeShippingGroupItemRelationship(ShippingGroupCommerceItemRelationship pShippingGroupItemRelationship, java.lang.Object pParam) Remove the given shipping group by setting its state to REMOVED If the group cannot be removed, then fail the Modification Assume the group is not PENDING_SHIPMENT This method adds the given relationship to the given pParam object and executes the chainToRun pipeline chain.
int	runProcess(java.lang.Object pParam, PipelineResult pResult) Removes all item relationships from the shipping group, the call is made to the chain that is responsible for removing.
void	setChainToRun(java.lang.String pChainToRun)

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

ProcRemoveShipItemRelsFromShippingGroup

public ProcRemoveShipItemRelsFromShippingGroup()

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.

getChainToRun

public java.lang.String getChainToRun()

setChainToRun

public void setChainToRun(java.lang.String pChainToRun)

runProcess

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

Removes all item relationships from the shipping group, the call is made to the chain that is responsible for removing. This method requires that an Order 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 an Order 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)

removeShippingGroupItemRelationship

protected boolean removeShippingGroupItemRelationship(HardgoodFulfiller of,
                                                      Order pOrder,
                                                      ShippingGroupCommerceItemRelationship pShippingGroupItemRelationship,
                                                      Modification pModification,
                                                      java.util.List pPerformedModifications)

Deprecated. use the version of this method that takes a ShippingGroupCommerceItemRelationship and an Object as the only two arguments

Remove the given shipping group by setting its state to REMOVED If the group cannot be removed, then fail the Modification Assume the group is not PENDING_SHIPMENT This method creates a new pipeline param object with the given parameters and executes the chainToRun pipeline chain.

Parameters:

pOrder - The order we are removing the shipping group item relationship from

pShippingGroupCommerceItemRelationship - The shipping group item relationship to remove

pModification - The modification request this action is in response to

pPerformedModifications - The list to store our performed modifications in

Returns:

true if the shipping group item relationship was successfully removed, false if the removal was not complete

removeShippingGroupItemRelationship

protected boolean removeShippingGroupItemRelationship(ShippingGroupCommerceItemRelationship pShippingGroupItemRelationship,
                                                      java.lang.Object pParam)

Remove the given shipping group by setting its state to REMOVED If the group cannot be removed, then fail the Modification Assume the group is not PENDING_SHIPMENT This method adds the given relationship to the given pParam object and executes the chainToRun pipeline chain.

Parameters:

pOrder - The order we are removing the shipping group item relationship from

pShippingGroupCommerceItemRelationship - The shipping group item relationship to remove

pModification - The modification request this action is in response to

pPerformedModifications - The list to store our performed modifications in

Returns:

true if the shipping group item relationship was successfully removed, false if the removal was not complete