com.ibm.commerce.utf.commands
Class ModifyOrderCommentsTCCmdImpl

java.lang.Object
  |
  +--CacheableCommandImpl
        |
        +--com.ibm.commerce.command.AbstractECTargetableCommand
              |
              +--com.ibm.commerce.command.TaskCommandImpl
                    |
                    +--com.ibm.commerce.utf.commands.ModifyOrderCommentsTCCmdImpl
All Implemented Interfaces:
ECCommand, ECTargetableCommand, ModifyOrderCommentsTCCmd, TaskCommand

public class ModifyOrderCommentsTCCmdImpl
extends TaskCommandImpl
implements ModifyOrderCommentsTCCmd

Implementation to modify terms and conditions of type "OrderComments".

This is the default implementation of the ModifyOrderCommentsTCCmd. This command uses the following Helper Class:

See Also:
Serialized Form

Field Summary
 java.util.Vector commentsVector
          Comment Vector.
 java.lang.Long tradingId
          Trading Id.
 
Fields inherited from class com.ibm.commerce.command. AbstractECTargetableCommand
commandContext
 
Fields inherited from interface com.ibm.commerce.utf.commands. ModifyOrderCommentsTCCmd
COPYRIGHT, defaultCommandClassName, NAME
 
Fields inherited from interface com.ibm.commerce.command. ECTargetableCommand
COPYRIGHT
 
Fields inherited from interface com.ibm.commerce.command. ECCommand
defaultCommandClassName
 
Constructor Summary
ModifyOrderCommentsTCCmdImpl()
          ModifyOrderCommentsTCCmdImpl constructor.
 
Method Summary
 java.util.Vector getCommentsVector()
          Retrieves a vector of freeform comments.
 java.lang.Long getTradingId()
          Retrieves the trading agreement ID.
 void performExecute()           Updates the term condition associated with each 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.
 
Methods inherited from class com.ibm.commerce.command. AbstractECTargetableCommand
accessControlCheck, checkIsAllowed, checkParameters, checkResourcePermission, createCommandExecutionEvent, execute, finalize, getAccCheck, getCommandContext, getCommandIfName, getCommandName, getCommandStoreId, getDefaultProperties, getResources, getStoreId, getUser, getUserId, isReadyToCallExecute, setAccCheck, setCommandContext, setCommandIfName, setCommandStoreId, setDefaultProperties
 
Methods inherited from class java.lang.Object
clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

tradingId

public java.lang.Long tradingId
Trading Id.

commentsVector

public java.util.Vector commentsVector
Comment Vector.
Constructor Detail

ModifyOrderCommentsTCCmdImpl

public ModifyOrderCommentsTCCmdImpl()
ModifyOrderCommentsTCCmdImpl constructor.
Method Detail

reset

public void reset()
Reset the 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
Updates the term condition associated with each incoming freeform comment.
Specified by:
performExecute in interface ECCommand
Overrides:
performExecute in class AbstractECTargetableCommand
Throws:
ECApplicationException - If an application error occurs while updating the TC.
ECSystemException - If a system error occurs while updating 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 ModifyOrderCommentsTCCmd
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 ModifyOrderCommentsTCCmd
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.
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.
  • ECException
    See Also:
    ECCommand#validateParameters()