com.ibm.commerce.utf.commands

Class CreateOrderCommentsTCCmdImpl

java.lang.Object

com.ibm.websphere.command.TargetableCommandImpl

com.ibm.websphere.command.CacheableCommandImpl

com.ibm.commerce.command.MeasuredCacheableCommandImpl

com.ibm.commerce.command.AbstractECTargetableCommand

com.ibm.commerce.command.TaskCommandImpl

com.ibm.commerce.utf.commands.CreateOrderCommentsTCCmdImpl

All Implemented Interfaces:

com.ibm.commerce.command.CacheableECCommand, ECCommand, ECTargetableCommand, TaskCommand, CreateOrderCommentsTCCmd, com.ibm.websphere.cache.Sizeable, com.ibm.websphere.command.CacheableCommand, com.ibm.websphere.command.Command, com.ibm.websphere.command.CommandCaller, com.ibm.websphere.command.TargetableCommand, java.io.Serializable

public class CreateOrderCommentsTCCmdImpl
extends TaskCommandImpl
implements CreateOrderCommentsTCCmd

Creates terms and conditions of type "OrderComments".

This command can be used to convert freeform terms and conditions input, during the course of a negotiation, into Terms and Conditions associated with a trading agreement. When an order results from a trading agreement, the OrderComment TCs will appear customer as comments in the prepared order.

Behaviour

The command loops through the list of freeform comments and does the following for each comment:

1. Composes an XML element for an OrderCommentTC that conforms to the Trading DTD.
2. Creates the OrderComment Term and Condition object using the XML element and the supplied trading agreement ID.

Exception conditions

• If the trading agreement ID is not provided.
• If the list of comments is not provided.

This is the default implementation of the CreateOrderCommentsTCCmd. This command uses the following AccessBeans:

• TradingAgreementAccessBean

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
java.util.Vector	commentsVector Comments Vector.
static java.lang.String	COPYRIGHT IBM copyright notice field.
java.lang.Long	tradingId Trading ID.

Fields inherited from class com.ibm.websphere.command.TargetableCommandImpl

LOCAL

Fields inherited from interface com.ibm.commerce.utf.commands.CreateOrderCommentsTCCmd

defaultCommandClassName, NAME

Fields inherited from interface com.ibm.websphere.command.Command

serialVersionUID

Constructor Summary

Constructors

Constructor and Description
CreateOrderCommentsTCCmdImpl() Default Constructor.

Method Summary

Modifier and Type	Method and Description
java.util.Vector	getCommentsVector() Retrieves a vector of freeform comments.
java.lang.Long	getTradingId() Retrieves the trading agreement ID.
void	performExecute() Creates one OrderComment TC for every incoming freeform comment.
void	reset() Reset the command.
void	setCommentsVector(java.util.Vector newCommentsVector) Stores the list of freeform comments that need to be converted into TCs.
void	setTradingId(java.lang.Long newTradingId) Stores the incoming trading agreement ID.
void	validateParameters() This method does the following: Verifies that a comment list has been provided. Verifies that a trading agreement ID has been provided. Verifies that the provided trading agreement ID exists.

Methods inherited from class com.ibm.commerce.command.AbstractECTargetableCommand

accessControlCheck, checkIsAllowed, checkResourcePermission, createCommandExecutionEvent, execute, getAccCheck, getCommandContext, getCommandIfName, getCommandName, getCommandStoreId, getDefaultProperties, getExceptionInvokeParameters, getObjectSize, getPostInvokeParameters, getPreInvokeParameters, getResources, getStoreId, getUser, getUserId, isReadyToCallExecute, setAccCheck, setCommandContext, setCommandIfName, setCommandStoreId, setDefaultProperties

Methods inherited from class com.ibm.websphere.command.CacheableCommandImpl

executeFromCache, getCaller, getEntryInfo, getId, getSharingPolicy, postExecute, preExecute, setCaller, setObjectSize, unionDependencies, updateCache

Methods inherited from class com.ibm.websphere.command.TargetableCommandImpl

getCommandTarget, getCommandTargetName, getTargetPolicy, hasOutputProperties, setCommandTarget, setCommandTargetName, setHasOutputProperties, setOutputProperties, setTargetPolicy

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.ibm.commerce.command.CacheableECCommand

execute

Methods inherited from interface com.ibm.websphere.command.CacheableCommand

executeFromCache, getCaller, getEntryInfo, getId, getSharingPolicy, postExecute, preExecute, setCaller, updateCache

Methods inherited from interface com.ibm.websphere.command.TargetableCommand

getCommandTarget, getCommandTargetName, hasOutputProperties, setCommandTarget, setCommandTargetName, setOutputProperties

Methods inherited from interface com.ibm.websphere.command.Command

isReadyToCallExecute

Methods inherited from interface com.ibm.websphere.command.CommandCaller

unionDependencies

Methods inherited from interface com.ibm.commerce.command.ECCommand

checkIsAllowed, checkResourcePermission, createCommandExecutionEvent, getAccCheck, getCommandContext, getCommandIfName, getCommandName, getCommandStoreId, getDefaultProperties, getExceptionInvokeParameters, getPostInvokeParameters, getPreInvokeParameters, getResources, getStoreId, getUser, getUserId, setAccCheck, setCommandContext, setCommandIfName, setCommandStoreId, setDefaultProperties

Field Detail

COPYRIGHT

public static final java.lang.String COPYRIGHT

IBM copyright notice field.

See Also:

Constant Field Values

tradingId

public java.lang.Long tradingId

Trading ID.

commentsVector

public java.util.Vector commentsVector

Comments Vector.

Constructor Detail

CreateOrderCommentsTCCmdImpl

public CreateOrderCommentsTCCmdImpl()

Default Constructor.

Method Detail

reset

public void reset()

Reset the command.

Specified by:

reset in interface com.ibm.websphere.command.Command

Overrides:

reset in class AbstractECTargetableCommand

getCommentsVector

public java.util.Vector getCommentsVector()

Retrieves a vector of freeform comments.

Returns:

The list of freeform comments that need to be converted into TCs.

getTradingId

public java.lang.Long getTradingId()

Retrieves the trading agreement ID.

Returns:

The ID of the trading agreement.

performExecute

public void performExecute()
                    throws ECException

Creates one OrderComment TC for every incoming freeform comment.

Specified by:

performExecute in interface ECCommand

Specified by:

performExecute in interface com.ibm.websphere.command.TargetableCommand

Overrides:

performExecute in class AbstractECTargetableCommand

Throws:

ECApplicationException - If an application error occurs while creating the TC.

ECSystemException - If a system error occurs while creating the TC.

ECException

See Also:

ECCommand#performExecute()

setCommentsVector

public void setCommentsVector(java.util.Vector newCommentsVector)

Stores the list of freeform comments that need to be converted into TCs.

Specified by:

setCommentsVector in interface CreateOrderCommentsTCCmd

Parameters:

newCommentsVector - The list of freeform comments.

setTradingId

public void setTradingId(java.lang.Long newTradingId)

Stores the incoming trading agreement ID.

Specified by:

setTradingId in interface CreateOrderCommentsTCCmd

Parameters:

newTradingId - The ID of the trading agreement.

validateParameters

public void validateParameters()
                        throws ECException

This method does the following:

1. Verifies that a comment list has been provided.
2. Verifies that a trading agreement ID has been provided.
3. Verifies that the provided trading agreement ID exists.

Specified by:

validateParameters in interface ECCommand

Overrides:

validateParameters in class AbstractECTargetableCommand

Throws:

ECApplicationException -

• If the comment list has not been provided.
• If the trading agreement ID has not been provided.
• If the trading agreement ID does not exist.

ECException

See Also:

ECCommand#validateParameters()