com.ibm.commerce.utf.commands
Class CreateOrderCommentsTCCmdImpl
java.lang.Object
|
+--com.ibm.commerce.command.AbstractECCommand
|
+--com.ibm.commerce.command.TaskCommandImpl
|
+--com.ibm.commerce.utf.commands.CreateOrderCommentsTCCmdImpl
- All Implemented Interfaces:
- CreateOrderCommentsTCCmd, ECCommand, TaskCommand
- 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:
- Composes an XML element for an OrderCommentTC that conforms
to the Trading DTD.
- 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.
Method Summary |
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 |
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.AbstractECCommand |
accessControlCheck, checkIsAllowed, checkResourcePermission, execute, finalize, getAccCheck, getCommandContext, getCommandIfName, getCommandName, getDefaultProperties, getResources, getStoreId, getUser, getUserId, isReadyToCallExecute, reset, setAccCheck, setCommandContext, setCommandIfName, setDefaultProperties |
Methods inherited from class java.lang.Object |
clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Methods inherited from interface com.ibm.commerce.command.ECCommand |
checkIsAllowed, checkResourcePermission, execute, getAccCheck, getCommandContext, getCommandIfName, getCommandName, getDefaultProperties, getResources, getStoreId, getUser, getUserId, setAccCheck, setCommandContext, setCommandIfName, setDefaultProperties |
commentsVector
public java.util.Vector commentsVector
tradingId
public java.lang.Long tradingId
CreateOrderCommentsTCCmdImpl
public CreateOrderCommentsTCCmdImpl()
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
- Overrides:
performExecute
in class AbstractECCommand
- Throws:
ECApplicationException
- If an application error occurs while creating the TC.ECSystemException
- If a system error occurs while creating the TC.
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:
- 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.
- Specified by:
validateParameters
in interface ECCommand
- Overrides:
validateParameters
in class AbstractECCommand
- 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.