atg.commerce.order

Interface HandlingInstructionContainer

All Superinterfaces:

java.io.Serializable

All Known Subinterfaces:

ShippingGroup

All Known Implementing Classes:

ElectronicShippingGroup, HandlingInstructionContainerImpl, HardgoodShippingGroup, InStorePickupShippingGroup, ShippingGroupImpl

public interface HandlingInstructionContainer
extends java.io.Serializable

Implemented by a class that contains and manages HandlingInstructions. This interface defines methods for getting, adding, and removing HandlingInstructions.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CLASS_VERSION Class version string

Method Summary

Modifier and Type	Method and Description
void	addHandlingInstruction(HandlingInstruction pHandlingInstruction) Add the HandlingInstruction to the container.
void	addHandlingInstruction(HandlingInstruction pHandlingInstruction, int pIndex) Add the HandlingInstruction to the container at the given index.
HandlingInstruction	getHandlingInstruction(java.lang.String pHandlingInstructionId) Returns the HandlingInstruction whose id is pHandlingInstructionId.
int	getHandlingInstructionCount() Returns the number of HandlingInstructions in the container.
java.util.List	getHandlingInstructions() Returns a List of HandlingInstructions
void	removeAllHandlingInstructions() Removes all the HandlingInstructions in the container.
HandlingInstruction	removeHandlingInstruction(java.lang.String pHandlingInstructionId) Removes a HandlingInstruction whose id is passed in.

Field Detail

CLASS_VERSION

static final java.lang.String CLASS_VERSION

Class version string

See Also:

Constant Field Values

Method Detail

getHandlingInstructions

java.util.List getHandlingInstructions()

Returns a List of HandlingInstructions

addHandlingInstruction

void addHandlingInstruction(HandlingInstruction pHandlingInstruction)
                     throws DuplicateHandlingInstructionException,
                            InvalidParameterException

Add the HandlingInstruction to the container. If the HandlingInstruction was already in the container a DuplicateHandlingInstructionException is thrown.

Throws:

DuplicateHandlingInstructionException

InvalidParameterException

addHandlingInstruction

void addHandlingInstruction(HandlingInstruction pHandlingInstruction,
                            int pIndex)
                     throws DuplicateHandlingInstructionException,
                            InvalidParameterException

Add the HandlingInstruction to the container at the given index. If the HandlingInstruction was already in the container a DuplicateHandlingInstructionException is thrown.

Throws:

DuplicateHandlingInstructionException

InvalidParameterException

removeHandlingInstruction

HandlingInstruction removeHandlingInstruction(java.lang.String pHandlingInstructionId)
                                       throws HandlingInstructionNotFoundException,
                                              InvalidParameterException

Removes a HandlingInstruction whose id is passed in. If the HandlingInstruction is not in the container then an HandlingInstructionNotFoundException is thrown. Otherwise a reference to the removed HandlingInstruction is returned.

Throws:

HandlingInstructionNotFoundException

InvalidParameterException

removeAllHandlingInstructions

void removeAllHandlingInstructions()

Removes all the HandlingInstructions in the container.

getHandlingInstruction

HandlingInstruction getHandlingInstruction(java.lang.String pHandlingInstructionId)
                                    throws HandlingInstructionNotFoundException,
                                           InvalidParameterException

Returns the HandlingInstruction whose id is pHandlingInstructionId. If the HandlingInstruction with the corresponding id is not in the container then a HandlingInstructionNotFoundException is thrown.

Throws:

HandlingInstructionNotFoundException

InvalidParameterException

getHandlingInstructionCount

int getHandlingInstructionCount()

Returns the number of HandlingInstructions in the container.