OrderCommentRecordContrlCmdImpl

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.ControllerCommandImpl
        
        com.ibm.commerce.order.commands.OrderCommentRecordContrlCmdImpl

All Implemented Interfaces:

AccCommand, ControllerCommand, ECCommand, ECTargetableCommand, OrderCommentRecordContrlCmd, Protectable, 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 OrderCommentRecordContrlCmdImpl
extends ControllerCommandImpl
implements OrderCommentRecordContrlCmd
```
This is the default implementation of the OrderCommentRecordContrlCmd controller command.
Behaviour
It gets the comments array from the request properties.
It will notify the shoppers if isNotifyShopper is true.
For the URL string ?comments_1="comments1"&comments_2="comments2"&changeReason_2="1001"&CSRId_0="-1000", The index 0 indicates all the comments are from this CSR -1000, also you can use CSRId_1="-1000"&CSRId_2="-1000" instead.

This command uses the following AccessBeans:
- OrderCommentAccessBean
- OrderAccessBean
This command calls the following command:
- CSROrderCommentsNotifyCmd

See Also:: Serialized Form

Field Summary

Fields
Modifier and Type Field and Description

static java.lang.String COPYRIGHT
The IBM copyright notice field.
- Fields inherited from class com.ibm.websphere.command.TargetableCommandImpl
  LOCAL
- Fields inherited from interface com.ibm.commerce.order.commands.OrderCommentRecordContrlCmd
  defaultCommandClassName, NAME
- Fields inherited from interface com.ibm.websphere.command.Command
  serialVersionUID

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`COPYRIGHT` The IBM copyright notice field.

Constructor Summary

Constructors
Constructor and Description

OrderCommentRecordContrlCmdImpl()

Constructors
Constructor and Description
`OrderCommentRecordContrlCmdImpl()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`callOrderCommentsNotifyCmd(java.lang.Long orderId)` The method calls `CSROrderCommentsNotifyCmd` command to send comment to a specified email address.
`java.lang.String[]`	`getComments()` This method gets the order comments.
`java.lang.String[]`	`getIsNotifyShopper()` This method gets the notifyShopper parameters
`java.lang.Long`	`getOrderId()` This method gets the order Id.
`java.lang.String[]`	`getReceiversEmailAddress()`
`AccessVector`	`getResources()` This method gets the access vector of OrderAccessBean accessed by this command.
`java.lang.String[]`	`getSubject()` This method gets the subject.
`void`	`performExecute()` This method executes the main business logic.
`void`	`reset()` This method resets the command for reusing.
`void`	`setBusinesssChannelId(java.lang.Integer[] arrBusinessChannelId)` This method sets the channel id from which the order change comments come.
`void`	`setComments(java.lang.String[] arrComments)` This method sets the comments for the changed Order.
`void`	`setCsrId(java.lang.Long[] arrCSRId)` This method sets the customer service representative Id array.
`void`	`setField1(java.lang.Integer[] arrField1)` This method sets the Field1 array.
`void`	`setField2(java.lang.String[] arrField2)` This method sets the Field2 array.
`void`	`setField3(java.sql.Timestamp[] arrField3)` This method sets the Field3 array.
`void`	`setIsNotifyShopper(java.lang.String[] strings)` This method sets if send email to shopper.
`void`	`setOrderchangeReasonId(java.lang.Integer[] arrOrderChangeReason)` This method sets the order change reason.
`void`	`setOrderId(java.lang.Long argOrderId)` This method sets the order id from which the order change comments come.
`void`	`setOrderVersion(java.lang.Short argOrderVersion)` This method sets the order version number which the order change comments are against.
`void`	`setReceiversEmailAddress(java.lang.String[] strings)` This method sets if send email to shopper.
`void`	`setRequestProperties(TypedProperty aRequestProperties)` This method sets the request properties of this command implementation.
`void`	`setSubject(java.lang.String[] argSubject)` This method sets the subjects of the email.
`void`	`validateParameters()` This method validates the parameter orderId is passed in.

Methods inherited from class com.ibm.commerce.command.ControllerCommandImpl
checkPermission, fulfills, getForUserId, getGeneric, getOwner, getRequestProperties, getResolvedRequestProperties, getResourceOwners, getResponseProperties, getRetriable, getViewInputProperties, isGeneric, isRetriable, mergeProperties, setForUserId, setGeneric, setOwner, setResponseProperties, setRetriable, setViewInputProperties

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.ControllerCommand
checkPermission, execute, getGeneric, getRequestProperties, getResolvedRequestProperties, getResponseProperties, getRetriable, getViewInputProperties, isGeneric, isRetriable, mergeProperties, setGeneric, setRetriable, setViewInputProperties

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.CommandCaller
unionDependencies

Methods inherited from interface com.ibm.commerce.command.AccCommand
accessControlCheck, getAccCheck, getForUserId, getResourceOwners, setAccCheck, setForUserId, setOwner

Methods inherited from interface com.ibm.commerce.command.ECCommand
checkIsAllowed, checkResourcePermission, createCommandExecutionEvent, getCommandContext, getCommandIfName, getCommandName, getCommandStoreId, getDefaultProperties, getExceptionInvokeParameters, getPostInvokeParameters, getPreInvokeParameters, getStoreId, getUser, getUserId, setCommandContext, setCommandIfName, setCommandStoreId, setDefaultProperties

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

Methods inherited from interface com.ibm.commerce.security.Protectable
fulfills, getOwner

- Field Detail
  - COPYRIGHT
```
public static final java.lang.String COPYRIGHT
```
    The IBM copyright notice field.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - OrderCommentRecordContrlCmdImpl
```
public OrderCommentRecordContrlCmdImpl()
```
- Method Detail
  - performExecute
```
public void performExecute()
                    throws ECException
```
    This method executes the main business logic.
    
    Specified by:
    
    performExecute in interface ECCommand
    
    Specified by:
    
    performExecute in interface com.ibm.websphere.command.TargetableCommand
    
    Overrides:
    
    performExecute in class AbstractECTargetableCommand
    
    Throws:
    
    ECException
  - callOrderCommentsNotifyCmd
```
public void callOrderCommentsNotifyCmd(java.lang.Long orderId)
                                throws ECException
```
    The method calls CSROrderCommentsNotifyCmd command to send comment to a specified email address.
    
    Parameters:
    
    orderId - The order ID.
    
    Throws:
    
    ECException - if the comment can not be sent.
  - setOrderchangeReasonId
```
public void setOrderchangeReasonId(java.lang.Integer[] arrOrderChangeReason)
```
    This method sets the order change reason.
    
    Specified by:
    
    setOrderchangeReasonId in interface OrderCommentRecordContrlCmd
    
    Parameters:
    
    arrOrderChangeReason - the order change reason Ids.
  - setComments
```
public void setComments(java.lang.String[] arrComments)
```
    This method sets the comments for the changed Order.
    
    Specified by:
    
    setComments in interface OrderCommentRecordContrlCmd
    
    Parameters:
    
    arrComments - the comments.
  - getComments
```
public java.lang.String[] getComments()
```
    This method gets the order comments.
    
    Returns:
    
    order comments.
  - setBusinesssChannelId
```
public void setBusinesssChannelId(java.lang.Integer[] arrBusinessChannelId)
```
    This method sets the channel id from which the order change comments come.
    
    Specified by:
    
    setBusinesssChannelId in interface OrderCommentRecordContrlCmd
    
    Parameters:
    
    arrBusinessChannelId - channel Id.
  - setCsrId
```
public void setCsrId(java.lang.Long[] arrCSRId)
```
    This method sets the customer service representative Id array.
    
    Specified by:
    
    setCsrId in interface OrderCommentRecordContrlCmd
    
    Parameters:
    
    arrCSRId - this is the array of customer service representative Id
  - setField1
```
public void setField1(java.lang.Integer[] arrField1)
```
    This method sets the Field1 array.
    
    Specified by:
    
    setField1 in interface OrderCommentRecordContrlCmd
    
    Parameters:
    
    arrField1 - array of field1.
  - setField2
```
public void setField2(java.lang.String[] arrField2)
```
    This method sets the Field2 array.
    
    Specified by:
    
    setField2 in interface OrderCommentRecordContrlCmd
    
    Parameters:
    
    arrField2 - array of Field2.
  - setField3
```
public void setField3(java.sql.Timestamp[] arrField3)
```
    This method sets the Field3 array.
    
    Specified by:
    
    setField3 in interface OrderCommentRecordContrlCmd
    
    Parameters:
    
    arrField3 - array of Field3.
  - setOrderId
```
public void setOrderId(java.lang.Long argOrderId)
```
    This method sets the order id from which the order change comments come.
    
    Specified by:
    
    setOrderId in interface OrderCommentRecordContrlCmd
    
    Parameters:
    
    argOrderId - the order Id.
  - setOrderVersion
```
public void setOrderVersion(java.lang.Short argOrderVersion)
```
    This method sets the order version number which the order change comments are against.
    
    Specified by:
    
    setOrderVersion in interface OrderCommentRecordContrlCmd
    
    Parameters:
    
    argOrderVersion - order version number.
  - getOrderId
```
public java.lang.Long getOrderId()
```
    This method gets the order Id.
    
    Returns:
    
    Order Id.
  - setSubject
```
public void setSubject(java.lang.String[] argSubject)
```
    This method sets the subjects of the email.
    
    Specified by:
    
    setSubject in interface OrderCommentRecordContrlCmd
    
    Parameters:
    
    argSubject - subjects of the email.
  - getSubject
```
public java.lang.String[] getSubject()
```
    This method gets the subject.
    
    Specified by:
    
    getSubject in interface OrderCommentRecordContrlCmd
    
    Returns:
    
    subject
  - setRequestProperties
```
public void setRequestProperties(TypedProperty aRequestProperties)
                          throws ECException
```
    This method sets the request properties of this command implementation.
    
    Specified by:
    
    setRequestProperties in interface ControllerCommand
    
    Overrides:
    
    setRequestProperties in class ControllerCommandImpl
    
    Parameters:
    
    aRequestProperties - the request property.
    
    Throws:
    
    ECException.
    
    ECException
    
    See Also:
    
    ControllerCommand.setRequestProperties(com.ibm.commerce.datatype.TypedProperty)
  - validateParameters
```
public void validateParameters()
                        throws ECException
```
    This method validates the parameter orderId is passed in.
    
    Specified by:
    
    validateParameters in interface ECCommand
    
    Overrides:
    
    validateParameters in class AbstractECTargetableCommand
    
    Throws:
    
    ECException - with _ERR_BAD_MISSING_CMD_PARAMETER will be thrown when orderId is not passed in.
    
    See Also:
    
    ECCommand.validateParameters()
  - reset
```
public void reset()
```
    This method resets the command for reusing.
    
    Specified by:
    
    reset in interface com.ibm.websphere.command.Command
    
    Overrides:
    
    reset in class AbstractECTargetableCommand
    
    See Also:
    
    Command.reset()
  - getResources
```
public AccessVector getResources()
                          throws ECException
```
    This method gets the access vector of OrderAccessBean accessed by this command.
    
    Specified by:
    
    getResources in interface ECCommand
    
    Overrides:
    
    getResources in class AbstractECTargetableCommand
    
    Returns:
    
    A vector of resource action pairs
    
    Throws:
    
    ECException - If the resource can not be retrieved.
  - getIsNotifyShopper
```
public java.lang.String[] getIsNotifyShopper()
```
    This method gets the notifyShopper parameters
    
    Returns:
    
    if notify shopper is needed
  - getReceiversEmailAddress
```
public java.lang.String[] getReceiversEmailAddress()
```
    Returns:
    
    String[]
  - setIsNotifyShopper
```
public void setIsNotifyShopper(java.lang.String[] strings)
```
    This method sets if send email to shopper.
    
    Specified by:
    
    setIsNotifyShopper in interface OrderCommentRecordContrlCmd
    
    Parameters:
    
    strings - if sent email to shopper.
  - setReceiversEmailAddress
```
public void setReceiversEmailAddress(java.lang.String[] strings)
```
    This method sets if send email to shopper.
    
    Specified by:
    
    setReceiversEmailAddress in interface OrderCommentRecordContrlCmd
    
    Parameters:
    
    strings - if sent email to shopper.

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

Fields inherited from interface com.ibm.commerce.order.commands.OrderCommentRecordContrlCmd

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

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

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

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

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

Methods inherited from class java.lang.Object

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

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

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

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

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

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

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

Methods inherited from interface com.ibm.commerce.security.Protectable

COPYRIGHT

OrderCommentRecordContrlCmdImpl

performExecute

callOrderCommentsNotifyCmd

setOrderchangeReasonId

setComments

getComments

setBusinesssChannelId

setCsrId

setField1

setField2

setField3

setOrderId

setOrderVersion

getOrderId

setSubject

getSubject

setRequestProperties

validateParameters

reset

getResources

getIsNotifyShopper

getReceiversEmailAddress

setIsNotifyShopper

setReceiversEmailAddress