com.ibm.commerce.tools.optools.user.commands
Class CSRCustomerInfoUpdateCmdImpl

com.ibm.commerce.command.AbstractECTargetableCommand
  |
  +--com.ibm.commerce.command.ControllerCommandImpl
        |
        +--com.ibm.commerce.tools.command.ToolsControllerCommandImpl
              |
              +--com.ibm.commerce.tools.optools.user.commands.CSRCustomerInfoUpdateCmdImpl
All Implemented Interfaces:
AccCommand, ControllerCommand, CSRCustomerInfoUpdateCmd, ECCommand, ECTargetableCommand, Protectable, ToolsControllerCommand

public class CSRCustomerInfoUpdateCmdImpl
extends ToolsControllerCommandImpl
implements CSRCustomerInfoUpdateCmd

Updates customer registration information by calling UserRegistrationAdminUpdateCmd.

URL calling syntax:

Parameters:
XML
An input xml_string that contains the all required data for updating the registration information for the customer.
Example xml_string:
       <?xml version="1.0" encoding "UTF-8">
       <userUpdated>false</userUpdated>
       <userProfileUpdated>true</userProfileUpdated>
       <addressUpdated>true</addressUpdated>
       <demographicsUpdated>false</demographicsUpdated>
       <userRegUpdated>false</userRegUpdated>
       <certStatusUpdated>false</certStatusUpdated>
       <customerId>20000</customerId>
       <profileInfo>
           <addressId>7777</addressId>
           <lastName>Smith</lastName>
           <firstName>John</firstName>
           <middleName>M.</middleName>
           <title>1</title>
       </profileInfo>
       <addressInfo>
       <address1>8200 Warden Ave.</address1>
       <address2>Building A2</address2>
       <address3>Unit 999</address3>
       <city>Markham</city>
       <state>Ontario</state>	
       <country>Canada</country>
           <zip>L3N 3R6</zip>
       </addressInfo>
       </xml>
 

Exceptions:


Field Summary
static java.lang.String COPYRIGHT
          copyright notice
 
Fields inherited from class com.ibm.commerce.command.ControllerCommandImpl
requestProperties, responseProperties, retriable, viewReqProperties
 
Fields inherited from class com.ibm.commerce.command.AbstractECTargetableCommand
commandContext
 
Fields inherited from interface com.ibm.commerce.tools.optools.user.commands.CSRCustomerInfoUpdateCmd
defaultCommandClassName
 
Fields inherited from interface com.ibm.commerce.tools.command.ToolsControllerCommand
NAME
 
Constructor Summary
CSRCustomerInfoUpdateCmdImpl()
          Default constructor.
 
Method Summary
protected  void exceptionUtil(TypedProperty prop, java.lang.Exception ex, java.lang.String methodName, java.lang.String cmdName, java.lang.String errMsg)
          Generates common exception code.
 void executeUserRegistrationAdminUpdate()
          Calls UserRegistrationAdminUpdateCmd to make all the user updates
 java.lang.String getAddress1()
          Returns the first line of the customer's address.
 java.lang.String getAddress2()
          Returns the second line of the customer's address.
 java.lang.String getAddress3()
          Returns the third line of the customer's address.
 java.lang.String getAddressId()
          Returns the address id of the customer's address.
 java.lang.String getAge()
          Returns the age of the customer.
 java.lang.String getAnnualIncome()
          Returns the annual income of the customer.
 java.lang.String getBestTimeToCall()
          Returns the best time to call the customer.
 java.lang.String getChallengeAnswer()
          Returns the answer to the customer's challenge question.
 java.lang.String getChallengeQuestion()
          Returns the customer's challenge question.
 java.lang.String getChildrenNum()
          Returns the number of children of the customer.
 java.lang.String getCity()
          Returns the customer's city.
 java.lang.String getCountry()
          Returns the customer's country or region.
 java.lang.String getCustomerId()
          Returns the customer's id.
 java.lang.String getEmail1()
          Returns the customer's e-mail address 1.
 java.lang.String getEmail2()
          Returns the customer's e-mail address 2.
 java.lang.String getEmployer()
          Returns the name of the customer's employer.
 java.lang.String getFax1()
          Returns the customer's fax number 1.
 java.lang.String getFax2()
          Returns the customer's fax number 2.
 java.lang.String getFirstName()
          Returns the customer's first name.
 java.lang.String getGender()
          Returns the customer's gender.
 java.lang.String getHobby()
          Returns the customer's hobby.
 java.lang.String getLastName()
          Returns the customer's last name.
 java.lang.String getLogonId()
          Returns the customer's logon id.
 java.lang.String getMaritalStatus()
          Returns the customer's marital status.
 java.lang.String getMiddleName()
          Returns the customer's middle name.
 java.util.Hashtable getNLS()
          Return the properties containing all translatable messages for this command.
 java.lang.String getOrderedBefore()
          Returns whether or not the customer has ordered before.
 java.lang.String getPackageInsert()
          Returns whether or not to include promotional material with shipments
 java.lang.String getPeopleNumInHouse()
          Returns the number of household members
 java.lang.String getPhone1()
          Returns the customer's phone number 1.
 java.lang.String getPhone1Listed()
          Returns whether customer's phone number 1 is listed.
 java.lang.String getPhone1Type()
          Returns what type of phone is customer phone number 1.
 java.lang.String getPhone2()
          Returns the customer's phone number 2.
 java.lang.String getPhone2Listed()
          Returns whether customer's phone number 2 is listed.
 java.lang.String getPhone2Type()
          Returns what type of phone is customer phone number 1.
 java.lang.String getPreferredCommunication()
          Returns the customer's preferred method of communication.
 java.lang.String getPreferredCurrency()
          Returns the customer's preferred currency.
 java.lang.String getPreferredLanguage()
          Returns the customer's preferred language.
 java.lang.String getPreviouslyOrdered()
          Returns whether or not the customer has ordered before.
 AccessVector getResources()
          Gets the access vector accessed by this command.
 java.lang.String getState()
          Returns the customer's state or province
 java.lang.String getTitle()
          Returns the customer's title.
 java.lang.String getUserAccountStatus()
          Returns whether the customer's account status (enabled or disabled).
 java.lang.String getXMLFile()
          Return the XML file.
 java.lang.String getZip()
          Return the customer's zip/postal code.
 boolean isAddressUpdated()
          Return a boolean denoting whether or not the customer's address information has been changed.
 boolean isDemographicsUpdated()
          Return a boolean denoting whether or not the customer's demographics information has been changed.
 boolean isUserProfileUpdated()
          Return a boolean denoting whether or not the customer's profile information (the preferred method of communication) has been changed.
 boolean isUserRegUpdated()
          Return a boolean denoting whether or not the customer's registration information has been changed.
 boolean isUserUpdated()
          Return a boolean denoting whether or not the customer's information has been changed.
 void performExecute()
          This method performs the execution for updating a customer's information.
 void setAddressUpdated(boolean newAddressUpdated)
          Sets whether or not the customer's address information has been changed.
 void setCertStatusUpdated(boolean newCertStatusUpdated)
          Sets whether or not the customer's X509 certificate status has been changed.
 void setDemographicsUpdated(boolean newDemographicsUpdated)
          Sets whether or not the customer's demographics information has been changed.
 void setNLS(java.util.Hashtable newNLS)
          Sets the NLS hashtable.
 void setUserProfileUpdated(boolean newUserProfileUpdated)
          Sets whether or not the customer's profile information (the preferred method of communication) has been changed.
 void setUserRegUpdated(boolean newUserRegUpdated)
          Sets whether or not the customer's registration information has been changed.
 void setUserUpdated(boolean newUserUpdated)
          Sets whether or not the customer's information has been changed.
 void validateParameters()
          Gets XMLObject from the GUI Notebook and gets ready to parse it.
 
Methods inherited from class com.ibm.commerce.tools.command.ToolsControllerCommandImpl
getViewInputProperties, setRequestProperties
 
Methods inherited from class com.ibm.commerce.command.ControllerCommandImpl
fulfills, getForUserId, getGeneric, getOwner, getRequestProperties, getResolvedRequestProperties, getResponseProperties, getRetriable, isGeneric, isRetriable, mergeProperties, setForUserId, setGeneric, setOwner, setResponseProperties, setRetriable, setViewInputProperties
 
Methods inherited from class com.ibm.commerce.command.AbstractECTargetableCommand
accessControlCheck, checkIsAllowed, checkResourcePermission, execute, finalize, getAccCheck, getCommandContext, getCommandIfName, getCommandName, getDefaultProperties, getStoreId, getUser, getUserId, isReadyToCallExecute, reset, setAccCheck, setCommandContext, setCommandIfName, setDefaultProperties
 
Methods inherited from interface com.ibm.commerce.command.ControllerCommand
execute, getGeneric, getRequestProperties, getResolvedRequestProperties, getResponseProperties, getRetriable, getViewInputProperties, isGeneric, isRetriable, mergeProperties, setGeneric, setRequestProperties, setRetriable, setViewInputProperties
 
Methods inherited from interface com.ibm.commerce.command.AccCommand
accessControlCheck, getAccCheck, getForUserId, setAccCheck, setForUserId, setOwner
 
Methods inherited from interface com.ibm.commerce.command.ECCommand
checkIsAllowed, checkResourcePermission, getCommandContext, getCommandIfName, getCommandName, getDefaultProperties, getStoreId, getUser, getUserId, setCommandContext, setCommandIfName, setDefaultProperties
 
Methods inherited from interface com.ibm.commerce.security.Protectable
fulfills, getOwner
 

Field Detail

COPYRIGHT

public static final java.lang.String COPYRIGHT
copyright notice
Constructor Detail

CSRCustomerInfoUpdateCmdImpl

public CSRCustomerInfoUpdateCmdImpl()
Default constructor.
Method Detail

exceptionUtil

protected void exceptionUtil(TypedProperty prop,
                             java.lang.Exception ex,
                             java.lang.String methodName,
                             java.lang.String cmdName,
                             java.lang.String errMsg)
                      throws ECApplicationException
Generates common exception code.
Parameters:
prop - The response typed property.
ex - The catched exception.
methodName - The method that generates the exception
cmdName - The command that generates the exception
Returns:
The response typed property of the exception
Throws:
ECApplicationException -  

executeUserRegistrationAdminUpdate

public void executeUserRegistrationAdminUpdate()
                                        throws java.lang.Exception
Calls UserRegistrationAdminUpdateCmd to make all the user updates
Throws:
ECApplicationException - If the UserRegistrationAdminUpdateCmd command cannot be found.

getAddress1

public java.lang.String getAddress1()
Returns the first line of the customer's address.
Returns:
java.lang.String

getAddress2

public java.lang.String getAddress2()
Returns the second line of the customer's address.
Returns:
java.lang.String

getAddress3

public java.lang.String getAddress3()
Returns the third line of the customer's address.
Returns:
java.lang.String

getAddressId

public java.lang.String getAddressId()
Returns the address id of the customer's address.
Returns:
java.lang.String

getAge

public java.lang.String getAge()
Returns the age of the customer.
Returns:
java.lang.String

getAnnualIncome

public java.lang.String getAnnualIncome()
Returns the annual income of the customer.
Returns:
java.lang.String

getBestTimeToCall

public java.lang.String getBestTimeToCall()
Returns the best time to call the customer.
Returns:
java.lang.String

getChallengeAnswer

public java.lang.String getChallengeAnswer()
Returns the answer to the customer's challenge question.
Returns:
java.lang.String

getChallengeQuestion

public java.lang.String getChallengeQuestion()
Returns the customer's challenge question.
Returns:
java.lang.String

getChildrenNum

public java.lang.String getChildrenNum()
Returns the number of children of the customer.
Returns:
java.lang.String

getCity

public java.lang.String getCity()
Returns the customer's city.
Returns:
java.lang.String

getCountry

public java.lang.String getCountry()
Returns the customer's country or region.
Returns:
java.lang.String

getCustomerId

public java.lang.String getCustomerId()
Returns the customer's id.
Returns:
java.lang.String

getEmail1

public java.lang.String getEmail1()
Returns the customer's e-mail address 1.
Returns:
java.lang.String

getEmail2

public java.lang.String getEmail2()
Returns the customer's e-mail address 2.
Returns:
java.lang.String

getEmployer

public java.lang.String getEmployer()
Returns the name of the customer's employer.
Returns:
java.lang.String

getFax1

public java.lang.String getFax1()
Returns the customer's fax number 1.
Returns:
java.lang.String

getFax2

public java.lang.String getFax2()
Returns the customer's fax number 2.
Returns:
java.lang.String

getFirstName

public java.lang.String getFirstName()
Returns the customer's first name.
Returns:
java.lang.String

getGender

public java.lang.String getGender()
Returns the customer's gender.
Returns:
java.lang.String

getHobby

public java.lang.String getHobby()
Returns the customer's hobby.
Returns:
java.lang.String

getLastName

public java.lang.String getLastName()
Returns the customer's last name.
Returns:
java.lang.String

getLogonId

public java.lang.String getLogonId()
Returns the customer's logon id.
Returns:
java.lang.String

getMaritalStatus

public java.lang.String getMaritalStatus()
Returns the customer's marital status.
Returns:
java.lang.String

getMiddleName

public java.lang.String getMiddleName()
Returns the customer's middle name.
Returns:
java.lang.String

getNLS

public java.util.Hashtable getNLS()
Return the properties containing all translatable messages for this command.
Returns:
java.util.Hashtable

getOrderedBefore

public java.lang.String getOrderedBefore()
Returns whether or not the customer has ordered before.
Returns:
java.lang.String

getPackageInsert

public java.lang.String getPackageInsert()
Returns whether or not to include promotional material with shipments
Returns:
java.lang.String

getPeopleNumInHouse

public java.lang.String getPeopleNumInHouse()
Returns the number of household members
Returns:
java.lang.String

getPhone1

public java.lang.String getPhone1()
Returns the customer's phone number 1.
Returns:
java.lang.Strings

getPhone1Listed

public java.lang.String getPhone1Listed()
Returns whether customer's phone number 1 is listed.
Returns:
java.lang.String

getPhone1Type

public java.lang.String getPhone1Type()
Returns what type of phone is customer phone number 1.
Returns:
java.lang.String

getPhone2

public java.lang.String getPhone2()
Returns the customer's phone number 2.
Returns:
java.lang.String

getPhone2Listed

public java.lang.String getPhone2Listed()
Returns whether customer's phone number 2 is listed.
Returns:
java.lang.String

getPhone2Type

public java.lang.String getPhone2Type()
Returns what type of phone is customer phone number 1.
Returns:
java.lang.String

getPreferredCommunication

public java.lang.String getPreferredCommunication()
Returns the customer's preferred method of communication.
Returns:
java.lang.String

getPreferredCurrency

public java.lang.String getPreferredCurrency()
Returns the customer's preferred currency.
Returns:
java.lang.String

getPreferredLanguage

public java.lang.String getPreferredLanguage()
Returns the customer's preferred language.
Returns:
java.lang.String

getPreviouslyOrdered

public java.lang.String getPreviouslyOrdered()
Returns whether or not the customer has ordered before.
Returns:
java.lang.String

getResources

public AccessVector getResources()
                          throws ECException
Gets the access vector accessed by this command. The default implementation returns null indicating that no protectable resource is accessed by this command.
Specified by:
getResources in interface ECCommand
Overrides:
getResources in class AbstractECTargetableCommand
Returns:
AccessVector - a vector of resource action pairs

getState

public java.lang.String getState()
Returns the customer's state or province
Returns:
java.lang.String

getTitle

public java.lang.String getTitle()
Returns the customer's title. For example, Mr. or Mrs.
Returns:
java.lang.String

getUserAccountStatus

public java.lang.String getUserAccountStatus()
Returns whether the customer's account status (enabled or disabled).
Returns:
java.lang.String

getXMLFile

public java.lang.String getXMLFile()
Return the XML file.
Returns:
java.lang.String The entire XML file in a string.

getZip

public java.lang.String getZip()
Return the customer's zip/postal code.
Returns:
java.lang.String

isAddressUpdated

public boolean isAddressUpdated()
Return a boolean denoting whether or not the customer's address information has been changed.
Returns:
boolean

isDemographicsUpdated

public boolean isDemographicsUpdated()
Return a boolean denoting whether or not the customer's demographics information has been changed.
Returns:
boolean

isUserProfileUpdated

public boolean isUserProfileUpdated()
Return a boolean denoting whether or not the customer's profile information (the preferred method of communication) has been changed.
Returns:
boolean

isUserRegUpdated

public boolean isUserRegUpdated()
Return a boolean denoting whether or not the customer's registration information has been changed.
Returns:
boolean

isUserUpdated

public boolean isUserUpdated()
Return a boolean denoting whether or not the customer's information has been changed.
Returns:
boolean

performExecute

public void performExecute()
                    throws ECException
This method performs the execution for updating a customer's information.
Specified by:
performExecute in interface ECCommand
Overrides:
performExecute in class AbstractECTargetableCommand
Throws:
ECException -  

setAddressUpdated

public void setAddressUpdated(boolean newAddressUpdated)
Sets whether or not the customer's address information has been changed.
Parameters:
newAddressUpdated - boolean

setCertStatusUpdated

public void setCertStatusUpdated(boolean newCertStatusUpdated)
Sets whether or not the customer's X509 certificate status has been changed.
Parameters:
newCertStatusUpdated - boolean

setDemographicsUpdated

public void setDemographicsUpdated(boolean newDemographicsUpdated)
Sets whether or not the customer's demographics information has been changed.
Parameters:
newDemographicsUpdated - boolean

setNLS

public void setNLS(java.util.Hashtable newNLS)
Sets the NLS hashtable.
Parameters:
newNLS - java.util.Hashtable

setUserProfileUpdated

public void setUserProfileUpdated(boolean newUserProfileUpdated)
Sets whether or not the customer's profile information (the preferred method of communication) has been changed.
Parameters:
newUserProfileUpdated - boolean

setUserRegUpdated

public void setUserRegUpdated(boolean newUserRegUpdated)
Sets whether or not the customer's registration information has been changed.
Parameters:
newUserRegUpdated - boolean

setUserUpdated

public void setUserUpdated(boolean newUserUpdated)
Sets whether or not the customer's information has been changed.
Parameters:
newUserUpdated - boolean

validateParameters

public void validateParameters()
                        throws ECApplicationException
Gets XMLObject from the GUI Notebook and gets ready to parse it.
Specified by:
validateParameters in interface ECCommand
Overrides:
validateParameters in class AbstractECTargetableCommand
Throws:
ECApplicationException - If the XML does not contain the required parameters