com.ibm.commerce.usermanagement.commands
Class UserRegistrationCmdImpl

java.lang.Object
  |
  +--CacheableCommandImpl
        |
        +--com.ibm.commerce.command.AbstractECTargetableCommand
              |
              +--com.ibm.commerce.command.ControllerCommandImpl
                    |
                    +--com.ibm.commerce.usermanagement.commands.UserRegistrationCmdImpl
All Implemented Interfaces:
AccCommand, ControllerCommand, ECCommand, ECTargetableCommand, UserRegistrationCmd
Direct Known Subclasses:
UserRegistrationAddCmdImpl, UserRegistrationAdminCmdImpl, UserRegistrationUpdateCmdImpl

public class UserRegistrationCmdImpl
extends ControllerCommandImpl
implements UserRegistrationCmd

Implementation class for the UserRegistrationCmd is the base command for the following user registration commands:

See Also:
Serialized Form

Field Summary
protected  UserAccessBean abUser
          The user access bean.
protected   UserRegistryAccessBean abUserRegistry
          The user registry bean.
protected  boolean bToolsFramework
          Whether the command is called by the tools framework.
static java.lang.String CLASSNAME
          The name of this implementation of the command.
static java.lang.String COPYRIGHT
          IBM Copyright notice field.
protected   OrganizationAccessBean iabParentOrgEntity
          The parent organization of the user.
protected  ManageBean imbUser
          The manager bean representing the member.
protected  java.lang.Integer inAge
          The age of the user.
protected  java.lang.Integer inChildren
           
protected  java.lang.Integer inDemographicsField6
           
protected  java.lang.Integer inHousehold
           
protected  java.lang.Integer inIncome
          The income of the user.
protected  java.lang.Long inOrganizationId
          The organization identifier.
protected  java.lang.Long inOrganizationUnitId
          The organizational unit identifier.
protected  java.lang.Integer inPackageSuppression
           
protected  java.lang.Integer inPasswordExpired
          Integer representation on whether the password expired.
protected  java.lang.Integer inPreferredLanguage
          The language identifier which represents the user's preferred language.
protected  java.lang.Integer inPrimary
           
protected  java.lang.Integer inPublishPhone1
           
protected  java.lang.Integer inPublishPhone2
           
protected  java.lang.Integer inUserStatus
          The integer representation of the user status.
protected  java.lang.String istrAddress1
           
protected  java.lang.String istrAddress2
           
protected  java.lang.String istrAddress3
           
protected  java.lang.String istrAddressField1
           
protected  java.lang.String istrAddressField2
           
protected  java.lang.String istrAddressField3
           
protected  java.lang.String istrAddressType
           
protected  java.lang.String istrAge
          The age demographic of the user.
protected  java.lang.String istrAlternateId
          The alternative identifier.
protected  java.lang.String istrAuthenticateMode
          The authentication mode.
protected  java.lang.String istrBestCallingTime
           
protected  java.lang.String istrBillingCode
           
protected  java.lang.String istrBillingCodeType
           
protected  java.lang.String istrBusinessTitle
           
protected  java.lang.String istrChallengeAnswer
          The challenge answer.
protected  java.lang.String istrChallengeQuestion
          The challenge question.
protected  java.lang.String istrChildren
           
protected  java.lang.String istrCity
           
protected  java.lang.String istrCompanyName
           
protected  java.lang.String istrCountry
           
protected  java.lang.String istrDemographicsField1
           
protected  java.lang.String istrDemographicsField2
           
protected  java.lang.String istrDemographicsField3
           
protected  java.lang.String istrDemographicsField4
           
protected  java.lang.String istrDemographicsField5
           
protected  java.lang.String istrDemographicsField6
           
protected  java.lang.String istrDemographicsField7
           
protected  java.lang.String istrDepartmentNumber
          The department number.
protected  java.lang.String istrDescription
          Description of the user.
protected  java.lang.String istrDisplayName
          The user display name.
protected  java.lang.String istrDistinguishedName
          The distinguished name of the user.
protected  java.lang.String istrEmail1
           
protected  java.lang.String istrEmail2
           
protected  java.lang.String istrEmployeeId
          The employee identifier.
protected  java.lang.String istrEmployeeType
          The employee type.
protected  java.lang.String istrEncipheredMerchantKey
           
protected  java.lang.String istrFax1
           
protected  java.lang.String istrFax2
           
protected  java.lang.String istrFirstName
           
protected  java.lang.String istrGender
          The user's gendar.
protected  java.lang.String istrHobbies
           
protected  java.lang.String istrHousehold
           
protected  java.lang.String istrIncome
          The income of the user.
protected  java.lang.String istrIncomeCurrency
          The income currency of the user.
protected  java.lang.String istrLastName
           
protected  java.lang.String istrLogonId
          The current logon identifier.
protected  java.lang.String istrLogonPassword
          The logon password.
protected  java.lang.String istrLogonPasswordVerify
          The logon password to confirm that the password is what the user wanted.
protected  java.lang.String istrManager
          Whether the employee is a manager or not.
protected  java.lang.String istrMaritalStatus
          The maritial status of the user.
protected  java.lang.String istrMerchantKey
           
protected  java.lang.String istrMiddleName
           
protected  java.lang.String istrNickName
           
protected  java.lang.String istrOfficeAddress
           
protected  java.lang.String istrOldLogonId
          The old logon identifier.
protected  java.lang.String istrOrderBefore
           
protected  java.lang.String istrOrganizationId
          The organization identifier.
protected  java.lang.String istrOrganizationName
           
protected  java.lang.String istrOrganizationUnitId
          The organizational unit identifier.
protected  java.lang.String istrOrganizationUnitName
           
protected  java.lang.String istrPackageSuppression
           
protected  java.lang.String istrPasswordExpired
          String representation on whether the password expired.
protected  java.lang.String istrPersonTitle
           
protected  java.lang.String istrPhone1
           
protected  java.lang.String istrPhone1Type
           
protected  java.lang.String istrPhone2
           
protected  java.lang.String istrPhone2Type
           
protected  java.lang.String istrPhoto
          The user photo.
protected  java.lang.String istrPreferredCommunication
          The user's preferred communication.
protected  java.lang.String istrPreferredCurrency
          The user's preferred currency.
protected  java.lang.String istrPreferredDelivery
          The user's preferred delivery.
protected  java.lang.String istrPreferredLanguage
          The string representation of the user's preferred language.
protected  java.lang.String istrPreferredMeasure
          The user's preferred measurement type.
protected  java.lang.String istrPrimary
           
protected  java.lang.String istrProfileType
          The profile type of the user.
protected  java.lang.String istrPublishPhone1
           
protected  java.lang.String istrPublishPhone2
           
protected  java.lang.String istrReceiveEmail
           
protected  java.lang.String istrRegisterType
          The registration type of the user.
protected  java.lang.String istrSecretary
          Whether the employee has an adimistrative assistant.
protected  java.lang.String istrSelfAddress
           
protected  java.lang.String istrShippingGeoCode
           
protected  java.lang.String istrState
           
protected  java.lang.String istrStatus
           
protected  java.lang.String istrTaxGeoCode
           
protected  java.lang.String istrTaxPayerId
          The tax identifier of the user.
protected  java.lang.String istrTimeZone
           
protected  java.lang.String istrURL
           
protected  java.lang.String istrUserField1
          Custom user field 1.
protected  java.lang.String istrUserField2
          Custom user field 2.
protected  java.lang.String istrUserField3
          Custom user field 3.
protected  java.lang.String istrUserProfileField1
          The user custom profile field 1.
protected  java.lang.String istrUserProfileField2
          The user custom profile field 2.
protected  java.lang.String istrUserStatus
          The string representation of the user status.
protected  java.lang.String istrWorkingUserId
          The user identifier.
protected  java.lang.String istrZipCode
           
protected  java.sql.Timestamp itmCreatedTimestamp
           
protected  java.sql.Timestamp itmLastLogon
          The last time the user logged on.
protected  java.sql.Timestamp itmLastOrder
          The last order made by the user.
protected  java.sql.Timestamp itmRegistration
          When the user registered.
protected  java.sql.Timestamp itmRegistrationCancel
          When the registered user had their registration cancelled.
protected  java.sql.Timestamp itmRegistrationUpdate
          The last time the user registration was updated.
 
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.usermanagement.commands. UserRegistrationCmd
NAME
 
Fields inherited from interface com.ibm.commerce.command. ECCommand
defaultCommandClassName
 
Constructor Summary
UserRegistrationCmdImpl()
           
 
Method Summary
 void checkAddParameters()
          Checks the parameters specified if the user is being added.
protected  boolean checkAncestorsLocked( OrganizationAccessBean abOrgEntity)
          Returns true if any parent organization is locked.
 void checkCommonParameters()
          Checks the common parameter which are the same no matter whether the user is being updated or added.
 void checkSelfRegistrationParameters()
          Checks the parameters specified if the user is registering him/her self.
 void checkUpdateParameters()
          Check the parametes specified when the user is being updated.
 void formulateDN( TypedProperty aProperties)
          Create the Distinguish name of the member based on the information specified.
 java.lang.String getAddress1()
          Returns the first line of the address.
 java.lang.String getAddress2()
          Returns the second line of the address.
 java.lang.String getAddress3()
          Returns the third line of the address.
 java.lang.String getAddressType()
          Returns the type of the address.
 java.lang.String getAuthenticateMode()
          The authentication mode.
 java.lang.String getBestCallingTime()
          Returns the best calling time.
 java.lang.String getBillingCode()
          Returns the billing code.
 java.lang.String getBillingCodeType()
          Returns the billing code type.
 java.lang.String getBusinessTitle()
          Returns the business title.
 java.lang.String getCity()
          Returns the city.
 java.lang.String getCountry()
          Returns the country.
 java.sql.Timestamp getCreatedTimestamp()
          Returns when the user was created.
 java.lang.String getEmail1()
          Returns the primary email address of the user.
 java.lang.String getEmail2()
          Returns the secondary email address of the user.
protected  java.lang.String getEncipheredMerchantKey()
          Returns the enciphered merchant key.
 java.lang.String getFax1()
          Returns the primary fax number.
 java.lang.String getFax2()
          Returns the secondary fax number.
 java.lang.String getFirstName()
          Returns the first name.
 java.lang.String getLastName()
          Returns the last name.
protected  java.lang.String getMerchantKey()
          Returns the merchant key.
 java.lang.String getMiddleName()
          Returns the middle name.
 java.lang.String getOfficeAddress()
          Returns the office address.
 java.lang.String getOrganizationName()
          Returns the organization name.
 java.lang.String getOrganizationUnitName()
          Returns the organizational unit name.
 java.lang.Integer getPackageSuppression()
          Returns the package suppression field.
 java.lang.String getPersonTitle()
          Returns the person's title.
 java.lang.String getPhone1()
          Returns the primary phone number.
 java.lang.String getPhone1Type()
          Returns the primary phone type.
 java.lang.String getPhone2()
          Returns the secondary phone number.
 java.lang.String getPhone2Type()
          Returns the secondary phone type.
 java.lang.Integer getPrimary()
          Returns the primary address.
 java.lang.String getProfileType()
          Returns the profile type.
 java.lang.Integer getPublishPhone1()
          Returns whether the primary phone number can be published.
 java.lang.Integer getPublishPhone2()
          Returns whether the secondary phone number can be published.
  TypedProperty getRequestProperties()
          Returns the request properties.
protected  java.util.Vector getRequiredRolesForUser(java.lang.Long user_id)
          Get required roles for user.
  AccessVector getResources()
          Returns the resources effected by this command.
 java.lang.String getState()
          Returns the current state of the user.
 java.lang.String getStatus()
          Returns the status of the user.
 java.lang.String getURL()
          Returns the URL to go to after the command executes.
  TypedProperty getViewInputProperties()
          Returns the request properties without the tools framework objects.
 java.lang.String getWorkingUserId()
          Get the user identifier of the user being created or updated.
 java.lang.String getZipCode()
          Returns the zip/postal code.
protected  boolean isAlphaNumeric(java.lang.String param)
          Indicates whether the paramater is alpha numeric.
 boolean isLogonIdExist(java.lang.String astrLogonId)
          This method check if the logon id already exists in the database or ldap server
 boolean isLogonIdExist(java.lang.String astrLogonId, java.lang.String astrAuthenticateMode)
          This method check if the logon id already exists in the database or ldap server
 boolean isLogonIdUnique(java.lang.String astrLogonId)
          Determines whether the specified logon id is unique.
 boolean isReadyToCallExecute()
          Indicates whether the command is ready to be executed.
protected  void logoffUserIfNotApproved(java.lang.String user_id)
          Logoff user if not approved.
 void performExecute()
          Either adds or updates the user's registration.
 void reset()
          Resets the state of the command so it can be reused to add/update another user.
 void setAddress1(java.lang.String astrAddress1)
          Sets the first line of the address.
 void setAddress2(java.lang.String astrAddress2)
          Sets the second line of the address.
 void setAddress3(java.lang.String astrAddress3)
          Sets the third line of that address.
 void setAddressField1(java.lang.String astrAddressField1)
          Sets the address field.
 void setAddressField2(java.lang.String astrAddressField2)
          Sets the additional address field.
 void setAddressField3(java.lang.String astrAddressField3)
          Sets the additional address field.
 void setAddressType(java.lang.String astrAddressType)
          Sets the address type.
 void setAge(java.lang.Integer anAge)
          Sets the age.
 void setAge(java.lang.String astrAge)
          Sets the age.
 void setAlternateId(java.lang.String astrAlternateId)
          Sets the alternate identifier of the user.
 void setAuthenticateMode(java.lang.String astrAuthenticateMode)
          Sets the authentication mode.
 void setBestCallingTime(java.lang.String astrBestCallingTime)
          Sets the best calling time.
 void setBillingCode(java.lang.String astrBillingCode)
          Sets the billing code.
 void setBillingCodeType(java.lang.String astrBillingCodeType)
          Sets the billing code type.
 void setBillingCodeTypeType(java.lang.String astrBillingCodeType)
          Sets the billing code type.
 void setBusinessTitle(java.lang.String astrBusinessTitle)
          Sets the business title.
 void setChallengeAnswer(java.lang.String astrChallengeAnswer)
          Sets the challenge answer.
 void setChallengeQuestion(java.lang.String astrChallengeQuestion)
          Sets the challenge question.
 void setChildren(java.lang.Integer anChildren)
          Sets the number of children.
 void setChildren(java.lang.String astrChildren)
          Sets the number of children.
 void setCity(java.lang.String astrCity)
          Sets the name of the city.
 void setCompanyName(java.lang.String astrCompanyName)
          Sets the name of the company.
 void setCountry(java.lang.String astrCountry)
          Sets the name of the country.
 void setCreatedTimestamp(java.sql.Timestamp atmCreatedTimestamp)
          Sets when the user was created.
 void setDemographicsField1(java.lang.String astrDemographicsField1)
          Sets the demographic field.
 void setDemographicsField2(java.lang.String astrDemographicsField2)
          Sets more demographic field information.
 void setDemographicsField3(java.lang.String astrDemographicsField3)
          Sets more demographic field information.
 void setDemographicsField4(java.lang.String astrDemographicsField4)
          Sets more demographic field information.
 void setDemographicsField5(java.lang.String astrDemographicsField5)
          Sets more demographic field information.
 void setDemographicsField6(java.lang.Integer anDemographicsField6)
          Sets more demographic field information.
 void setDemographicsField6(java.lang.String astrDemographicsField6)
          Sets more demographic field information.
 void setDemographicsField7(java.lang.String astrDemographicsField7)
          Sets more demographic field information.
 void setDepartmentNumber(java.lang.String astrDepartmentNumber)
          Sets the department number.
 void setDescription(java.lang.String astrDescription)
          Sets the description.
 void setDisplayName(java.lang.String astrDisplayName)
          Sets the display name.
 void setDistinguishedName(java.lang.String astrDistinguishedName)
          Sets the distinguished name.
 void setEmail1(java.lang.String astrEmail1)
          Sets the primary email address.
 void setEmail2(java.lang.String astrEmail2)
          Sets the secondary email address.
 void setEmployeeId(java.lang.String astrEmployeeId)
          Sets the employee identifier.
 void setEmployeeType(java.lang.String astrEmployeeType)
          Sets the employee type.
 void setEncipheredMerchantKey(java.lang.String strEncipheredMerchantKey)
          Sets the enciphered merchant key.
 void setFax1(java.lang.String astrFax1)
          Sets the primary fax number.
 void setFax2(java.lang.String astrFax2)
          Sets the secondary fax number.
 void setFirstName(java.lang.String astrFirstName)
          Sets the first name.
 void setGender(java.lang.String astrGender)
          Sets the gender.
 void setHobbies(java.lang.String astrHobbies)
          Sets the hobbies.
 void setHousehold(java.lang.Integer anHousehold)
          Sets the number of people in the user's house hold.
 void setHousehold(java.lang.String astrHousehold)
          Sets the number of people in the user's house hold.
 void setIncome(java.lang.Integer anIncome)
          Sets the user's income.
 void setIncome(java.lang.String astrIncome)
          Sets the user's income.
 void setIncomeCurrency(java.lang.String astrIncomeCurrency)
          Sts the currency of the user's income.
 void setLastName(java.lang.String astrLastName)
          Sets the last name.
 void setLogonId(java.lang.String astrLogonId)
          Sets the logon id.
 void setLogonPassword(java.lang.String astrLogonPassword)
          Sets the logon password.
 void setLogonPasswordVerify(java.lang.String astrLogonPasswordVerify)
          Sets the password value for verification.
 void setLogonPasswordVerifyVerify(java.lang.String astrLogonPasswordVerify)
          Sts the logon password for verification.
 void setManager(java.lang.String astrManager)
          Sets the manager.
 void setMaritalStatus(java.lang.String astrMaritalStatus)
          Sets the marital status.
 void setMerchantKey(java.lang.String strMerchantKey)
          Sets the merchant key.
 void setMiddleName(java.lang.String astrMiddleName)
          Sets the middle name.
 void setNickName(java.lang.String astrNickName)
          Sets the nick name.
 void setOfficeAddress(java.lang.String astrOfficeAddress)
          Sets the office address.
 void setOrderBefore(java.lang.String astrOrderBefore)
          Sets the orders of the user.
 void setOrganizationId(java.lang.Long anOrganizationId)
          Sets the organization of the user.
 void setOrganizationId(java.lang.String astrOrganizationId)
          Sets the organization of the user.
 void setOrganizationName(java.lang.String astrOrganizationName)
          Sets the organization name.
 void setOrganizationUnitId(java.lang.Long anOrganizationUnitId)
          Sts the organizational unit.
 void setOrganizationUnitId(java.lang.String astrOrganizationUnitId)
          Sets the organizational unit.
 void setOrganizationUnitName(java.lang.String astrOrganizationUnitName)
          Sets the name of the organizational unit.
 void setPackageSuppression(java.lang.Integer anPackageSuppression)
          Sets the package suppression flag.
 void setPackageSuppression(java.lang.String astrPackageSuppression)
          Sets the package suppression flag.
 void setPasswordExpired(java.lang.Integer anPasswordExpired)
          Sets whether the password expired.
 void setPasswordExpired(java.lang.String astrPasswordExpired)
          Sets whether the password expired.
 void setPersonTitle(java.lang.String astrPersonTitle)
          Sets the person's title.
 void setPhone1(java.lang.String astrPhone1)
          Sets the primary phone number.
 void setPhone1Type(java.lang.String astrPhone1Type)
          Sets the primary phone type.
 void setPhone2(java.lang.String astrPhone2)
          Sets the secondary phone number.
 void setPhone2Type(java.lang.String astrPhone2Type)
          Sets the secondary phone type.
 void setPhoto(java.lang.String astrPhoto)
          Sets the photo.
 void setPreferredCommunication(java.lang.String astrPreferredCommunication)
          Sets the preferred method of communication.
 void setPreferredCurrency(java.lang.String astrPreferredCurrency)
          Sets the preferred currency.
 void setPreferredDelivery(java.lang.String astrPreferredDelivery)
          Sets the preferred delivery.
 void setPreferredLanguage(java.lang.Integer anPreferredLanguage)
          Sets the preferred language.
 void setPreferredLanguage(java.lang.String astrPreferredLanguage)
          Sets the preferred language.
 void setPreferredMeasure(java.lang.String astrPreferredMeasure)
          Sets the preferred unit of measurement.
 void setPrimary(java.lang.Integer anPrimary)
          Sets the primary address.
 void setPrimary(java.lang.String astrPrimary)
          Sets the primary address.
 void setProfileType(java.lang.String astrProfileType)
          Sets the profile type.
 void setPublishPhone1(java.lang.Integer anPublishPhone1)
          Sets whether to publish the primary phone number.
 void setPublishPhone1(java.lang.String astrPublishPhone1)
          Sets whether to publish the primary phone number.
 void setPublishPhone2(java.lang.Integer anPublishPhone2)
          Sets whether to publish the secondary phone number.
 void setPublishPhone2(java.lang.String astrPublishPhone2)
          Sets whether to publish the secondary phone number.
 void setRequestProperties( TypedProperty reqProperties)
          Sets the request properties.
protected  void setRolesForMemberInOrg(java.lang.Long member_id, java.util.Vector roles_in_org)
          Set roles for member in org.
 void setSecretary(java.lang.String astrSecretary)
          Sets the name of the admin assistant.
 void setShippingGeoCode(java.lang.String astrShippingGeoCode)
          Sets the shipping code.
 void setState(java.lang.String astrState)
          Sets the state of user.
 void setStatus(java.lang.String astrStatus)
          Sets the status of the user.
 void setTaxGeoCode(java.lang.String astrTaxGeoCode)
          Sets the tax geo code.
 void setTaxPayerId(java.lang.String astrTaxPayerId)
          Sets the tax payer identifier.
 void setTimeZone(java.lang.String astrTimeZone)
          Sets the time zone.
 void setURL(java.lang.String astrURL)
          Sets the URL to go to after execution.
 void setUserField1(java.lang.String astrUserField1)
          Sets the user field 1.
 void setUserField2(java.lang.String astrUserField2)
          Sets the user field 1.
 void setUserField3(java.lang.String astrUserField3)
          Sets the user field 1.
 void setUserProfileField1(java.lang.String astrUserProfileField1)
          Sets the user profile field 1.
 void setUserProfileField2(java.lang.String astrUserProfileField2)
          Sets the user profile field 1.
 void setUserStatus(java.lang.Integer anUserStatus)
          Sets the user status.
 void setUserStatus(java.lang.String astrUserStatus)
          Sets the user status.
 void setWorkingUserId(java.lang.String astrUserId)
          Sets the working user identifier.
 void setZipCode(java.lang.String astrZipCode)
          Sets the zip/postal code.
protected  void UpdateCredentials(java.lang.String astrLogonId, java.lang.String astrLogonPassword)
          Update the user's credentials.
protected  void UpdatePreferredCurrency(java.lang.String astrPreferredCurrency)
          Update the currency.
protected  void UpdatePreferredLanguage(java.lang.String astrPreferredLanguage)
          Update the preferred language.
protected  void UpdateReceiveEmail(java.lang.String astrReceiveEmail)
          Set whether the user should receive email activities.
 void validateParameters()
          Validates the parameters.
 
Methods inherited from class com.ibm.commerce.command. ControllerCommandImpl
checkPermission, fulfills, getForUserId, getGeneric, getOwner, getResolvedRequestProperties, getResourceOwners, getResponseProperties, getRetriable, isGeneric, isRetriable, mergeProperties, setForUserId, setGeneric, setOwner, setResponseProperties, setRetriable, setViewInputProperties
 
Methods inherited from class com.ibm.commerce.command. AbstractECTargetableCommand
accessControlCheck, checkIsAllowed, checkParameters, checkResourcePermission, createCommandExecutionEvent, execute, finalize, getAccCheck, getCommandContext, getCommandIfName, getCommandName, getCommandStoreId, getDefaultProperties, getStoreId, getUser, getUserId, setAccCheck, setCommandContext, setCommandIfName, setCommandStoreId, 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. ControllerCommand
checkPermission, execute, getGeneric, getResolvedRequestProperties, getResponseProperties, getRetriable, isGeneric, isRetriable, mergeProperties, setGeneric, setRetriable, setViewInputProperties
 
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, getStoreId, getUser, getUserId, setCommandContext, setCommandIfName, setCommandStoreId, setDefaultProperties
 

Field Detail
public static final java.lang.String COPYRIGHT
IBM Copyright notice field.
See Also:
Constant Field Values

CLASSNAME

public static final java.lang.String CLASSNAME
The name of this implementation of the command.
See Also:
Constant Field Values

istrWorkingUserId

protected java.lang.String istrWorkingUserId
The user identifier.

imbUser

protected ManageBean imbUser
The manager bean representing the member.

istrRegisterType

protected java.lang.String istrRegisterType
The registration type of the user.

istrProfileType

protected java.lang.String istrProfileType
The profile type of the user.

bToolsFramework

protected boolean bToolsFramework
Whether the command is called by the tools framework.

iabParentOrgEntity

protected OrganizationAccessBean iabParentOrgEntity
The parent organization of the user.

istrAuthenticateMode

protected java.lang.String istrAuthenticateMode
The authentication mode.

abUser

protected UserAccessBean abUser
The user access bean.

abUserRegistry

protected UserRegistryAccessBean abUserRegistry
The user registry bean.

istrOldLogonId

protected java.lang.String istrOldLogonId
The old logon identifier.

istrLogonId

protected java.lang.String istrLogonId
The current logon identifier.

istrLogonPassword

protected java.lang.String istrLogonPassword
The logon password.

istrLogonPasswordVerify

protected java.lang.String istrLogonPasswordVerify
The logon password to confirm that the password is what the user wanted.

istrUserStatus

protected java.lang.String istrUserStatus
The string representation of the user status.

inUserStatus

protected java.lang.Integer inUserStatus
The integer representation of the user status.

istrPasswordExpired

protected java.lang.String istrPasswordExpired
String representation on whether the password expired.

inPasswordExpired

protected java.lang.Integer inPasswordExpired
Integer representation on whether the password expired.

itmLastLogon

protected java.sql.Timestamp itmLastLogon
The last time the user logged on.

istrChallengeQuestion

protected java.lang.String istrChallengeQuestion
The challenge question.

istrChallengeAnswer

protected java.lang.String istrChallengeAnswer
The challenge answer.

istrDistinguishedName

protected java.lang.String istrDistinguishedName
The distinguished name of the user.

itmRegistration

protected java.sql.Timestamp itmRegistration
When the user registered.

itmRegistrationCancel

protected java.sql.Timestamp itmRegistrationCancel
When the registered user had their registration cancelled.

itmRegistrationUpdate

protected java.sql.Timestamp itmRegistrationUpdate
The last time the user registration was updated.

itmLastOrder

protected java.sql.Timestamp itmLastOrder
The last order made by the user.

istrPreferredCurrency

protected java.lang.String istrPreferredCurrency
The user's preferred currency.

istrPreferredLanguage

protected java.lang.String istrPreferredLanguage
The string representation of the user's preferred language.

inPreferredLanguage

protected java.lang.Integer inPreferredLanguage
The language identifier which represents the user's preferred language.

istrUserField1

protected java.lang.String istrUserField1
Custom user field 1.

istrUserField2

protected java.lang.String istrUserField2
Custom user field 2.

istrUserField3

protected java.lang.String istrUserField3
Custom user field 3.

istrDisplayName

protected java.lang.String istrDisplayName
The user display name.

istrPhoto

protected java.lang.String istrPhoto
The user photo.

istrPreferredMeasure

protected java.lang.String istrPreferredMeasure
The user's preferred measurement type.

istrPreferredCommunication

protected java.lang.String istrPreferredCommunication
The user's preferred communication.

istrPreferredDelivery

protected java.lang.String istrPreferredDelivery
The user's preferred delivery.

istrDescription

protected java.lang.String istrDescription
Description of the user.

istrTaxPayerId

protected java.lang.String istrTaxPayerId
The tax identifier of the user.

istrUserProfileField1

protected java.lang.String istrUserProfileField1
The user custom profile field 1.

istrUserProfileField2

protected java.lang.String istrUserProfileField2
The user custom profile field 2.

istrOrganizationId

protected java.lang.String istrOrganizationId
The organization identifier.

inOrganizationId

protected java.lang.Long inOrganizationId
The organization identifier.

istrOrganizationUnitId

protected java.lang.String istrOrganizationUnitId
The organizational unit identifier.

inOrganizationUnitId

protected java.lang.Long inOrganizationUnitId
The organizational unit identifier.

istrEmployeeId

protected java.lang.String istrEmployeeId
The employee identifier.

istrAlternateId

protected java.lang.String istrAlternateId
The alternative identifier.

istrEmployeeType

protected java.lang.String istrEmployeeType
The employee type.

istrDepartmentNumber

protected java.lang.String istrDepartmentNumber
The department number.

istrManager

protected java.lang.String istrManager
Whether the employee is a manager or not.

istrSecretary

protected java.lang.String istrSecretary
Whether the employee has an adimistrative assistant.

istrGender

protected java.lang.String istrGender
The user's gendar.

istrAge

protected java.lang.String istrAge
The age demographic of the user.

inAge

protected java.lang.Integer inAge
The age of the user.

istrIncome

protected java.lang.String istrIncome
The income of the user.

inIncome

protected java.lang.Integer inIncome
The income of the user.

istrIncomeCurrency

protected java.lang.String istrIncomeCurrency
The income currency of the user.

istrMaritalStatus

protected java.lang.String istrMaritalStatus
The maritial status of the user.

istrChildren

protected java.lang.String istrChildren

inChildren

protected java.lang.Integer inChildren

istrHousehold

protected java.lang.String istrHousehold

inHousehold

protected java.lang.Integer inHousehold

istrCompanyName

protected java.lang.String istrCompanyName

istrHobbies

protected java.lang.String istrHobbies

istrOrderBefore

protected java.lang.String istrOrderBefore

istrTimeZone

protected java.lang.String istrTimeZone

istrDemographicsField1

protected java.lang.String istrDemographicsField1

istrDemographicsField2

protected java.lang.String istrDemographicsField2

istrDemographicsField3

protected java.lang.String istrDemographicsField3

istrDemographicsField4

protected java.lang.String istrDemographicsField4

istrDemographicsField5

protected java.lang.String istrDemographicsField5

istrDemographicsField6

protected java.lang.String istrDemographicsField6

inDemographicsField6

protected java.lang.Integer inDemographicsField6

istrDemographicsField7

protected java.lang.String istrDemographicsField7

istrSelfAddress

protected java.lang.String istrSelfAddress

istrBillingCode

protected java.lang.String istrBillingCode

istrBillingCodeType

protected java.lang.String istrBillingCodeType

istrOrganizationName

protected java.lang.String istrOrganizationName

istrOrganizationUnitName

protected java.lang.String istrOrganizationUnitName

inPrimary

protected java.lang.Integer inPrimary

istrPrimary

protected java.lang.String istrPrimary

istrAddress1

protected java.lang.String istrAddress1

istrAddress2

protected java.lang.String istrAddress2

istrAddress3

protected java.lang.String istrAddress3

istrAddressType

protected java.lang.String istrAddressType

istrStatus

protected java.lang.String istrStatus

istrNickName

protected java.lang.String istrNickName

istrPersonTitle

protected java.lang.String istrPersonTitle

istrBusinessTitle

protected java.lang.String istrBusinessTitle

istrLastName

protected java.lang.String istrLastName

istrFirstName

protected java.lang.String istrFirstName

istrMiddleName

protected java.lang.String istrMiddleName

istrOfficeAddress

protected java.lang.String istrOfficeAddress

istrCity

protected java.lang.String istrCity

istrState

protected java.lang.String istrState

istrCountry

protected java.lang.String istrCountry

istrZipCode

protected java.lang.String istrZipCode

istrPhone1

protected java.lang.String istrPhone1

istrPhone2

protected java.lang.String istrPhone2

istrFax1

protected java.lang.String istrFax1

istrFax2

protected java.lang.String istrFax2

istrEmail1

protected java.lang.String istrEmail1

istrEmail2

protected java.lang.String istrEmail2

istrPhone1Type

protected java.lang.String istrPhone1Type

istrPhone2Type

protected java.lang.String istrPhone2Type

inPublishPhone1

protected java.lang.Integer inPublishPhone1

istrPublishPhone1

protected java.lang.String istrPublishPhone1

inPublishPhone2

protected java.lang.Integer inPublishPhone2

istrPublishPhone2

protected java.lang.String istrPublishPhone2

istrBestCallingTime

protected java.lang.String istrBestCallingTime

inPackageSuppression

protected java.lang.Integer inPackageSuppression

istrPackageSuppression

protected java.lang.String istrPackageSuppression

itmCreatedTimestamp

protected java.sql.Timestamp itmCreatedTimestamp

istrShippingGeoCode

protected java.lang.String istrShippingGeoCode

istrTaxGeoCode

protected java.lang.String istrTaxGeoCode

istrAddressField1

protected java.lang.String istrAddressField1

istrAddressField2

protected java.lang.String istrAddressField2

istrAddressField3

protected java.lang.String istrAddressField3

istrURL

protected java.lang.String istrURL

istrMerchantKey

protected java.lang.String istrMerchantKey

istrEncipheredMerchantKey

protected java.lang.String istrEncipheredMerchantKey

istrReceiveEmail

protected java.lang.String istrReceiveEmail
Constructor Detail

UserRegistrationCmdImpl

public UserRegistrationCmdImpl()
Method Detail

checkAddParameters

public void checkAddParameters()
                        throws ECException
Checks the parameters specified if the user is being added.
Throws:
ECException - If there are any missing or invalid parameters.

checkCommonParameters

public void checkCommonParameters()
                           throws ECException
Checks the common parameter which are the same no matter whether the user is being updated or added.
Throws:
ECException - If there are any missing or invalid parameters.

checkSelfRegistrationParameters

public void checkSelfRegistrationParameters()
                                     throws ECException
Checks the parameters specified if the user is registering him/her self.
Throws:
ECException - If there are any invalid or missing parameters.

checkUpdateParameters

public void checkUpdateParameters()
                           throws ECException
Check the parametes specified when the user is being updated.
Throws:
ECException - If there are invalid or missing parameters specified.

formulateDN

public void formulateDN(TypedProperty aProperties)
                 throws ECException
Create the Distinguish name of the member based on the information specified. The distinguish name is based on the parent member and the user's relative distinguish name.
Parameters:
aProperties - the parameter of the user.
Throws:
ECException - If the parent member does not exist or the distinguish name is already in use.

getAddress1

public java.lang.String getAddress1()
Returns the first line of the address.
Specified by:
getAddress1 in interface UserRegistrationCmd
Returns:
The first line of the address.

getAddress2

public java.lang.String getAddress2()
Returns the second line of the address.
Specified by:
getAddress2 in interface UserRegistrationCmd
Returns:
The second line of the address.

getAddress3

public java.lang.String getAddress3()
Returns the third line of the address.
Specified by:
getAddress3 in interface UserRegistrationCmd
Returns:
The third line of the address.

getAddressType

public java.lang.String getAddressType()
Returns the type of the address.
Specified by:
getAddressType in interface UserRegistrationCmd
Returns:
The type of the address.

getAuthenticateMode

public java.lang.String getAuthenticateMode()
The authentication mode.
Specified by:
getAuthenticateMode in interface UserRegistrationCmd
Returns:
The authentication mode.

getBestCallingTime

public java.lang.String getBestCallingTime()
Returns the best calling time.
Specified by:
getBestCallingTime in interface UserRegistrationCmd
Returns:
The best calling time.

getBillingCode

public java.lang.String getBillingCode()
Returns the billing code.
Specified by:
getBillingCode in interface UserRegistrationCmd
Returns:
The billing code.

getBillingCodeType

public java.lang.String getBillingCodeType()
Returns the billing code type.
Specified by:
getBillingCodeType in interface UserRegistrationCmd
Returns:
The billing code type.

getBusinessTitle

public java.lang.String getBusinessTitle()
Returns the business title.
Specified by:
getBusinessTitle in interface UserRegistrationCmd
Returns:
The business title.

getCity

public java.lang.String getCity()
Returns the city.
Specified by:
getCity in interface UserRegistrationCmd
Returns:
The name of the city.

getCountry

public java.lang.String getCountry()
Returns the country.
Specified by:
getCountry in interface UserRegistrationCmd
Returns:
The name of the country.

getCreatedTimestamp

public java.sql.Timestamp getCreatedTimestamp()
Returns when the user was created.
Specified by:
getCreatedTimestamp in interface UserRegistrationCmd
Returns:
The creation date of the user.

getEmail1

public java.lang.String getEmail1()
Returns the primary email address of the user.
Specified by:
getEmail1 in interface UserRegistrationCmd
Returns:
The primary email address.

getEmail2

public java.lang.String getEmail2()
Returns the secondary email address of the user.
Specified by:
getEmail2 in interface UserRegistrationCmd
Returns:
The secondary email address.

getEncipheredMerchantKey

protected java.lang.String getEncipheredMerchantKey()
Returns the enciphered merchant key.
Returns:
The enciphered merchant key.

getFax1

public java.lang.String getFax1()
Returns the primary fax number.
Specified by:
getFax1 in interface UserRegistrationCmd
Returns:
The primary fax number.

getFax2

public java.lang.String getFax2()
Returns the secondary fax number.
Specified by:
getFax2 in interface UserRegistrationCmd
Returns:
The secondary fax number.

getFirstName

public java.lang.String getFirstName()
Returns the first name.
Specified by:
getFirstName in interface UserRegistrationCmd
Returns:
The first name.

getLastName

public java.lang.String getLastName()
Returns the last name.
Specified by:
getLastName in interface UserRegistrationCmd
Returns:
The last name.

getMerchantKey

protected java.lang.String getMerchantKey()
Returns the merchant key.
Returns:
The merchant key.

getMiddleName

public java.lang.String getMiddleName()
Returns the middle name.
Specified by:
getMiddleName in interface UserRegistrationCmd
Returns:
The middle name.

getOfficeAddress

public java.lang.String getOfficeAddress()
Returns the office address.
Specified by:
getOfficeAddress in interface UserRegistrationCmd
Returns:
The office address.

getOrganizationName

public java.lang.String getOrganizationName()
Returns the organization name.
Specified by:
getOrganizationName in interface UserRegistrationCmd
Returns:
The organization name.

getOrganizationUnitName

public java.lang.String getOrganizationUnitName()
Returns the organizational unit name.
Specified by:
getOrganizationUnitName in interface UserRegistrationCmd
Returns:
The organizational unit name.

getPackageSuppression

public java.lang.Integer getPackageSuppression()
Returns the package suppression field.
Specified by:
getPackageSuppression in interface UserRegistrationCmd
Returns:
The package suppression field.

getPersonTitle

public java.lang.String getPersonTitle()
Returns the person's title.
Specified by:
getPersonTitle in interface UserRegistrationCmd
Returns:
The person's title.

getPhone1

public java.lang.String getPhone1()
Returns the primary phone number.
Specified by:
getPhone1 in interface UserRegistrationCmd
Returns:
The primary phone number.

getPhone1Type

public java.lang.String getPhone1Type()
Returns the primary phone type.
Specified by:
getPhone1Type in interface UserRegistrationCmd
Returns:
The phone type.

getPhone2

public java.lang.String getPhone2()
Returns the secondary phone number.
Specified by:
getPhone2 in interface UserRegistrationCmd
Returns:
The secondary phone number.

getPhone2Type

public java.lang.String getPhone2Type()
Returns the secondary phone type.
Specified by:
getPhone2Type in interface UserRegistrationCmd
Returns:
The phone type.

getPrimary

public java.lang.Integer getPrimary()
Returns the primary address.
Specified by:
getPrimary in interface UserRegistrationCmd
Returns:
The identifier of the primary address.

getProfileType

public java.lang.String getProfileType()
Returns the profile type.
Specified by:
getProfileType in interface UserRegistrationCmd
Returns:
The profile type.

getPublishPhone1

public java.lang.Integer getPublishPhone1()
Returns whether the primary phone number can be published.
Specified by:
getPublishPhone1 in interface UserRegistrationCmd
Returns:
Whether the phone number can be published.

getPublishPhone2

public java.lang.Integer getPublishPhone2()
Returns whether the secondary phone number can be published.
Specified by:
getPublishPhone2 in interface UserRegistrationCmd
Returns:
Wether the phone number can be published.

getRequestProperties

public TypedProperty getRequestProperties()
Returns the request properties.
Specified by:
getRequestProperties in interface ControllerCommand
Overrides:
getRequestProperties in class ControllerCommandImpl
Returns:
The request properties.

getResources

public AccessVector getResources()
                          throws ECException
Returns the resources effected by this command.
Specified by:
getResources in interface ECCommand
Overrides:
getResources in class AbstractECTargetableCommand
Returns:
An AccessVector that contains the user being updated or the parent organization which the user is registered under.
ECException

getState

public java.lang.String getState()
Returns the current state of the user.
Specified by:
getState in interface UserRegistrationCmd
Returns:
The current state of the user.

getStatus

public java.lang.String getStatus()
Returns the status of the user.
Specified by:
getStatus in interface UserRegistrationCmd
Returns:
The status of the user.

getURL

public java.lang.String getURL()
Returns the URL to go to after the command executes.
Returns:
The URL to go to after execution.

getViewInputProperties

public TypedProperty getViewInputProperties()
Returns the request properties without the tools framework objects.
Specified by:
getViewInputProperties in interface ControllerCommand
Overrides:
getViewInputProperties in class ControllerCommandImpl
Returns:
The request properties.

getWorkingUserId

public java.lang.String getWorkingUserId()
Get the user identifier of the user being created or updated.
Specified by:
getWorkingUserId in interface UserRegistrationCmd
Returns:
An user identifier.

getZipCode

public java.lang.String getZipCode()
Returns the zip/postal code.
Specified by:
getZipCode in interface UserRegistrationCmd
Returns:
The zip/postal code.

isAlphaNumeric

protected boolean isAlphaNumeric(java.lang.String param)
Indicates whether the paramater is alpha numeric.
Parameters:
param - the argument to test.
Returns:
Whether it is alpha numeric or not.

isLogonIdExist

public boolean isLogonIdExist(java.lang.String astrLogonId)
This method check if the logon id already exists in the database or ldap server
Parameters:
astrLogonId - The logon id to check
Returns:
boolean
  • true - the logon id is found in the database or ldap server
  • false - the logon id does not exist in the database and ldap srever

isLogonIdExist

public boolean isLogonIdExist(java.lang.String astrLogonId,
                              java.lang.String astrAuthenticateMode)
This method check if the logon id already exists in the database or ldap server
Parameters:
astrLogonId - The logon id to check
Returns:
boolean
  • true - the logon id is found in the database or ldap server
  • false - the logon id does not exist in the database and ldap srever

isLogonIdUnique

public boolean isLogonIdUnique(java.lang.String astrLogonId)
                        throws ECException
Determines whether the specified logon id is unique.
Parameters:
astrLogonId - the logon id to test.
Returns:
Whether the logon id is unique.
Throws:
ECException - If there was a problem checking the logon id.

isReadyToCallExecute

public boolean isReadyToCallExecute()
Indicates whether the command is ready to be executed.
Overrides:
isReadyToCallExecute in class AbstractECTargetableCommand
Returns:
Is the command ready to execute.

performExecute

public void performExecute()
                    throws ECException
Either adds or updates the user's registration.
Specified by:
performExecute in interface ECCommand
Overrides:
performExecute in class AbstractECTargetableCommand
Throws:
ECException - If there is a problem adding or updating the user.

UpdateReceiveEmail

protected void UpdateReceiveEmail(java.lang.String astrReceiveEmail)
                           throws ECException
Set whether the user should receive email activities.
Parameters:
astrReceiveEmail - Whether the email should be received.
Throws:
ECException - Updates wehther the user should receive email activities.

reset

public void reset()
Resets the state of the command so it can be reused to add/update another user.
Specified by:
reset in interface UserRegistrationCmd
Overrides:
reset in class AbstractECTargetableCommand

setAddress1

public void setAddress1(java.lang.String astrAddress1)
Sets the first line of the address.
Specified by:
setAddress1 in interface UserRegistrationCmd
Parameters:
astrAddress1 - the first line of the address.

setAddress2

public void setAddress2(java.lang.String astrAddress2)
Sets the second line of the address.
Specified by:
setAddress2 in interface UserRegistrationCmd
Parameters:
astrAddress2 - the second line of the address.

setAddress3

public void setAddress3(java.lang.String astrAddress3)
Sets the third line of that address.
Specified by:
setAddress3 in interface UserRegistrationCmd
Parameters:
astrAddress3 - the third line of the address.

setAddressField1

public void setAddressField1(java.lang.String astrAddressField1)
Sets the address field.
Specified by:
setAddressField1 in interface UserRegistrationCmd
Parameters:
astrAddressField1 - the address field.

setAddressField2

public void setAddressField2(java.lang.String astrAddressField2)
Sets the additional address field.
Specified by:
setAddressField2 in interface UserRegistrationCmd
Parameters:
astrAddressField2 - the address field.

setAddressField3

public void setAddressField3(java.lang.String astrAddressField3)
Sets the additional address field.
Specified by:
setAddressField3 in interface UserRegistrationCmd
Parameters:
astrAddressField3 - the address field.

setAddressType

public void setAddressType(java.lang.String astrAddressType)
Sets the address type.
Specified by:
setAddressType in interface UserRegistrationCmd
Parameters:
astrAddressType - the address type.

setAge

public void setAge(java.lang.Integer anAge)
Sets the age.
Specified by:
setAge in interface UserRegistrationCmd
Parameters:
anAge - the age.

setAge

public void setAge(java.lang.String astrAge)
Sets the age.
Specified by:
setAge in interface UserRegistrationCmd
Parameters:
astrAge - the age.

setAlternateId

public void setAlternateId(java.lang.String astrAlternateId)
Sets the alternate identifier of the user.
Specified by:
setAlternateId in interface UserRegistrationCmd
Parameters:
astrAlternateId - the alternate identifier.

setAuthenticateMode

public void setAuthenticateMode(java.lang.String astrAuthenticateMode)
Sets the authentication mode.
Specified by:
setAuthenticateMode in interface UserRegistrationCmd
Parameters:
astrAuthenticateMode - the authentication mode.

setBestCallingTime

public void setBestCallingTime(java.lang.String astrBestCallingTime)
Sets the best calling time.
Specified by:
setBestCallingTime in interface UserRegistrationCmd
Parameters:
astrBestCallingTime - the best calling time.

setBillingCode

public void setBillingCode(java.lang.String astrBillingCode)
Sets the billing code.
Specified by:
setBillingCode in interface UserRegistrationCmd
Parameters:
astrBillingCode - the billing code.

setBillingCodeType

public void setBillingCodeType(java.lang.String astrBillingCodeType)
Sets the billing code type.
Specified by:
setBillingCodeType in interface UserRegistrationCmd
Parameters:
astrBillingCodeType - the billing code type.

setBillingCodeTypeType

public void setBillingCodeTypeType(java.lang.String astrBillingCodeType)
Sets the billing code type.
Parameters:
astrBillingCodeType - the billing code type.

setBusinessTitle

public void setBusinessTitle(java.lang.String astrBusinessTitle)
Sets the business title.
Specified by:
setBusinessTitle in interface UserRegistrationCmd
Parameters:
astrBusinessTitle - the business title.

setChallengeAnswer

public void setChallengeAnswer(java.lang.String astrChallengeAnswer)
Sets the challenge answer.
Specified by:
setChallengeAnswer in interface UserRegistrationCmd
Parameters:
astrChallengeAnswer - the challenge answer.

setChallengeQuestion

public void setChallengeQuestion(java.lang.String astrChallengeQuestion)
Sets the challenge question.
Specified by:
setChallengeQuestion in interface UserRegistrationCmd
Parameters:
astrChallengeQuestion - the challenge question.

setChildren

public void setChildren(java.lang.Integer anChildren)
Sets the number of children.
Specified by:
setChildren in interface UserRegistrationCmd
Parameters:
anChildren - the number of children.

setChildren

public void setChildren(java.lang.String astrChildren)
Sets the number of children.
Specified by:
setChildren in interface UserRegistrationCmd
Parameters:
astrChildren - the number of children.

setCity

public void setCity(java.lang.String astrCity)
Sets the name of the city.
Specified by:
setCity in interface UserRegistrationCmd
Parameters:
astrCity - the name of the city.

setCompanyName

public void setCompanyName(java.lang.String astrCompanyName)
Sets the name of the company.
Specified by:
setCompanyName in interface UserRegistrationCmd
Parameters:
astrCompanyName - the company name.

setCountry

public void setCountry(java.lang.String astrCountry)
Sets the name of the country.
Specified by:
setCountry in interface UserRegistrationCmd
Parameters:
astrCountry - the name of the country.

setCreatedTimestamp

public void setCreatedTimestamp(java.sql.Timestamp atmCreatedTimestamp)
Sets when the user was created.
Specified by:
setCreatedTimestamp in interface UserRegistrationCmd
Parameters:
atmCreatedTimestamp - the date and time the user was created.

setDemographicsField1

public void setDemographicsField1(java.lang.String astrDemographicsField1)
Sets the demographic field.
Specified by:
setDemographicsField1 in interface UserRegistrationCmd
Parameters:
astrDemographicsField1 - the demographic field.

setDemographicsField2

public void setDemographicsField2(java.lang.String astrDemographicsField2)
Sets more demographic field information.
Specified by:
setDemographicsField2 in interface UserRegistrationCmd
Parameters:
astrDemographicsField2 - the demographic field.

setDemographicsField3

public void setDemographicsField3(java.lang.String astrDemographicsField3)
Sets more demographic field information.
Specified by:
setDemographicsField3 in interface UserRegistrationCmd
Parameters:
astrDemographicsField3 - the demographic field.

setDemographicsField4

public void setDemographicsField4(java.lang.String astrDemographicsField4)
Sets more demographic field information.
Specified by:
setDemographicsField4 in interface UserRegistrationCmd
Parameters:
astrDemographicsField4 - The demographic field4 reserved for customization

setDemographicsField5

public void setDemographicsField5(java.lang.String astrDemographicsField5)
Sets more demographic field information.
Specified by:
setDemographicsField5 in interface UserRegistrationCmd
Parameters:
astrDemographicsField5 - Thedemographic field5 reserved for customization

setDemographicsField6

public void setDemographicsField6(java.lang.Integer anDemographicsField6)
Sets more demographic field information.
Specified by:
setDemographicsField6 in interface UserRegistrationCmd
Parameters:
anDemographicsField6 - The demographic field6 reserved for customization

setDemographicsField6

public void setDemographicsField6(java.lang.String astrDemographicsField6)
Sets more demographic field information.
Specified by:
setDemographicsField6 in interface UserRegistrationCmd
Parameters:
astrDemographicsField6 - The demographic field6 reserved for customization

setDemographicsField7

public void setDemographicsField7(java.lang.String astrDemographicsField7)
Sets more demographic field information.
Specified by:
setDemographicsField7 in interface UserRegistrationCmd
Parameters:
astrDemographicsField7 - The demographic field7 reserved for customization

setDepartmentNumber

public void setDepartmentNumber(java.lang.String astrDepartmentNumber)
Sets the department number.
Specified by:
setDepartmentNumber in interface UserRegistrationCmd
Parameters:
astrDepartmentNumber - the department number.

setDescription

public void setDescription(java.lang.String astrDescription)
Sets the description.
Specified by:
setDescription in interface UserRegistrationCmd
Parameters:
astrDescription - the description.

setDisplayName

public void setDisplayName(java.lang.String astrDisplayName)
Sets the display name.
Specified by:
setDisplayName in interface UserRegistrationCmd
Parameters:
astrDisplayName - the display name.

setDistinguishedName

public void setDistinguishedName(java.lang.String astrDistinguishedName)
Sets the distinguished name.
Specified by:
setDistinguishedName in interface UserRegistrationCmd
Parameters:
astrDistinguishedName - the distinguished name.

setEmail1

public void setEmail1(java.lang.String astrEmail1)
Sets the primary email address.
Specified by:
setEmail1 in interface UserRegistrationCmd
Parameters:
astrEmail1 - an email address.

setEmail2

public void setEmail2(java.lang.String astrEmail2)
Sets the secondary email address.
Specified by:
setEmail2 in interface UserRegistrationCmd
Parameters:
astrEmail2 - an email address.

setEmployeeId

public void setEmployeeId(java.lang.String astrEmployeeId)
Sets the employee identifier.
Specified by:
setEmployeeId in interface UserRegistrationCmd
Parameters:
astrEmployeeId - the employee identifier.

setEmployeeType

public void setEmployeeType(java.lang.String astrEmployeeType)
Sets the employee type.
Specified by:
setEmployeeType in interface UserRegistrationCmd
Parameters:
astrEmployeeType - the employee type.

setEncipheredMerchantKey

public void setEncipheredMerchantKey(java.lang.String strEncipheredMerchantKey)
Sets the enciphered merchant key.
Specified by:
setEncipheredMerchantKey in interface UserRegistrationCmd
Parameters:
strEncipheredMerchantKey - the enciphered merchant key.

setFax1

public void setFax1(java.lang.String astrFax1)
Sets the primary fax number.
Specified by:
setFax1 in interface UserRegistrationCmd
Parameters:
astrFax1 - a fax number.

setFax2

public void setFax2(java.lang.String astrFax2)
Sets the secondary fax number.
Specified by:
setFax2 in interface UserRegistrationCmd
Parameters:
astrFax2 - a fax number.

setFirstName

public void setFirstName(java.lang.String astrFirstName)
Sets the first name.
Specified by:
setFirstName in interface UserRegistrationCmd
Parameters:
astrFirstName - the first name.

setGender

public void setGender(java.lang.String astrGender)
Sets the gender.
Specified by:
setGender in interface UserRegistrationCmd
Parameters:
astrGender - the gender.

setHobbies

public void setHobbies(java.lang.String astrHobbies)
Sets the hobbies.
Specified by:
setHobbies in interface UserRegistrationCmd
Parameters:
astrHobbies - the user's hobbies.

setHousehold

public void setHousehold(java.lang.Integer anHousehold)
Sets the number of people in the user's house hold.
Specified by:
setHousehold in interface UserRegistrationCmd
Parameters:
anHousehold - the number of people in the house hold.

setHousehold

public void setHousehold(java.lang.String astrHousehold)
Sets the number of people in the user's house hold.
Specified by:
setHousehold in interface UserRegistrationCmd
Parameters:
astrHousehold - the number of people in the house hold.

setIncome

public void setIncome(java.lang.Integer anIncome)
Sets the user's income.
Specified by:
setIncome in interface UserRegistrationCmd
Parameters:
anIncome - the user's income.

setIncome

public void setIncome(java.lang.String astrIncome)
Sets the user's income.
Specified by:
setIncome in interface UserRegistrationCmd
Parameters:
astrIncome - the user's income.

setIncomeCurrency

public void setIncomeCurrency(java.lang.String astrIncomeCurrency)
Sts the currency of the user's income.
Specified by:
setIncomeCurrency in interface UserRegistrationCmd
Parameters:
astrIncomeCurrency - the currency.

setLastName

public void setLastName(java.lang.String astrLastName)
Sets the last name.
Specified by:
setLastName in interface UserRegistrationCmd
Parameters:
astrLastName - the last name.

setLogonId

public void setLogonId(java.lang.String astrLogonId)
Sets the logon id.
Specified by:
setLogonId in interface UserRegistrationCmd
Parameters:
astrLogonId - the logon id.

setLogonPassword

public void setLogonPassword(java.lang.String astrLogonPassword)
Sets the logon password.
Specified by:
setLogonPassword in interface UserRegistrationCmd
Parameters:
astrLogonPassword - the logon password.

setLogonPasswordVerify

public void setLogonPasswordVerify(java.lang.String astrLogonPasswordVerify)
Sets the password value for verification.
Specified by:
setLogonPasswordVerify in interface UserRegistrationCmd
Parameters:
astrLogonPasswordVerify - the logon password.

setLogonPasswordVerifyVerify

public void setLogonPasswordVerifyVerify(java.lang.String astrLogonPasswordVerify)
Sts the logon password for verification.
Parameters:
astrLogonPasswordVerify - the logon password.

setManager

public void setManager(java.lang.String astrManager)
Sets the manager.
Specified by:
setManager in interface UserRegistrationCmd
Parameters:
astrManager - the manager.

setMaritalStatus

public void setMaritalStatus(java.lang.String astrMaritalStatus)
Sets the marital status.
Specified by:
setMaritalStatus in interface UserRegistrationCmd
Parameters:
astrMaritalStatus - the marital status.

setMerchantKey

public void setMerchantKey(java.lang.String strMerchantKey)
Sets the merchant key.
Specified by:
setMerchantKey in interface UserRegistrationCmd
Parameters:
strMerchantKey - the merchant key.

setMiddleName

public void setMiddleName(java.lang.String astrMiddleName)
Sets the middle name.
Specified by:
setMiddleName in interface UserRegistrationCmd
Parameters:
astrMiddleName - the middle name.

setNickName

public void setNickName(java.lang.String astrNickName)
Sets the nick name.
Parameters:
astrNickName - the nick name.

setOfficeAddress

public void setOfficeAddress(java.lang.String astrOfficeAddress)
Sets the office address.
Specified by:
setOfficeAddress in interface UserRegistrationCmd
Parameters:
astrOfficeAddress - the office address.

setOrderBefore

public void setOrderBefore(java.lang.String astrOrderBefore)
Sets the orders of the user.
Specified by:
setOrderBefore in interface UserRegistrationCmd
Parameters:
astrOrderBefore - the orders of the user.

setOrganizationId

public void setOrganizationId(java.lang.Long anOrganizationId)
Sets the organization of the user.
Specified by:
setOrganizationId in interface UserRegistrationCmd
Parameters:
anOrganizationId - an organization.

setOrganizationId

public void setOrganizationId(java.lang.String astrOrganizationId)
Sets the organization of the user.
Specified by:
setOrganizationId in interface UserRegistrationCmd
Parameters:
astrOrganizationId - an organization.

setOrganizationName

public void setOrganizationName(java.lang.String astrOrganizationName)
Sets the organization name.
Specified by:
setOrganizationName in interface UserRegistrationCmd
Parameters:
astrOrganizationName - the organization name.

setOrganizationUnitId

public void setOrganizationUnitId(java.lang.Long anOrganizationUnitId)
Sts the organizational unit.
Specified by:
setOrganizationUnitId in interface UserRegistrationCmd
Parameters:
anOrganizationUnitId - the organizational unit.

setOrganizationUnitId

public void setOrganizationUnitId(java.lang.String astrOrganizationUnitId)
Sets the organizational unit.
Specified by:
setOrganizationUnitId in interface UserRegistrationCmd
Parameters:
astrOrganizationUnitId - the organizational unit.

setOrganizationUnitName

public void setOrganizationUnitName(java.lang.String astrOrganizationUnitName)
Sets the name of the organizational unit.
Specified by:
setOrganizationUnitName in interface UserRegistrationCmd
Parameters:
astrOrganizationUnitName - the organizational unit name.

setPackageSuppression

public void setPackageSuppression(java.lang.Integer anPackageSuppression)
Sets the package suppression flag.
Specified by:
setPackageSuppression in interface UserRegistrationCmd
Parameters:
anPackageSuppression - the package suppression flag.

setPackageSuppression

public void setPackageSuppression(java.lang.String astrPackageSuppression)
Sets the package suppression flag.
Specified by:
setPackageSuppression in interface UserRegistrationCmd
Parameters:
astrPackageSuppression - the package suppression flag.

setPasswordExpired

public void setPasswordExpired(java.lang.Integer anPasswordExpired)
Sets whether the password expired.
Specified by:
setPasswordExpired in interface UserRegistrationCmd
Parameters:
anPasswordExpired - whether the password expired.

setPasswordExpired

public void setPasswordExpired(java.lang.String astrPasswordExpired)
Sets whether the password expired.
Specified by:
setPasswordExpired in interface UserRegistrationCmd
Parameters:
astrPasswordExpired - whether the password expired.

setPersonTitle

public void setPersonTitle(java.lang.String astrPersonTitle)
Sets the person's title.
Specified by:
setPersonTitle in interface UserRegistrationCmd
Parameters:
astrPersonTitle - the person's title.

setPhone1

public void setPhone1(java.lang.String astrPhone1)
Sets the primary phone number.
Specified by:
setPhone1 in interface UserRegistrationCmd
Parameters:
astrPhone1 - a phone number.

setPhone1Type

public void setPhone1Type(java.lang.String astrPhone1Type)
Sets the primary phone type.
Specified by:
setPhone1Type in interface UserRegistrationCmd
Parameters:
astrPhone1Type - the phone type.

setPhone2

public void setPhone2(java.lang.String astrPhone2)
Sets the secondary phone number.
Specified by:
setPhone2 in interface UserRegistrationCmd
Parameters:
astrPhone2 - a phone number.

setPhone2Type

public void setPhone2Type(java.lang.String astrPhone2Type)
Sets the secondary phone type.
Specified by:
setPhone2Type in interface UserRegistrationCmd
Parameters:
astrPhone2Type - a phone type.

setPhoto

public void setPhoto(java.lang.String astrPhoto)
Sets the photo.
Specified by:
setPhoto in interface UserRegistrationCmd
Parameters:
astrPhoto - the photo.

setPreferredCommunication

public void setPreferredCommunication(java.lang.String astrPreferredCommunication)
Sets the preferred method of communication.
Specified by:
setPreferredCommunication in interface UserRegistrationCmd
Parameters:
astrPreferredCommunication - preferred method of communication.

setPreferredCurrency

public void setPreferredCurrency(java.lang.String astrPreferredCurrency)
Sets the preferred currency.
Specified by:
setPreferredCurrency in interface UserRegistrationCmd
Parameters:
astrPreferredCurrency - the preferred currency.

setPreferredDelivery

public void setPreferredDelivery(java.lang.String astrPreferredDelivery)
Sets the preferred delivery.
Specified by:
setPreferredDelivery in interface UserRegistrationCmd
Parameters:
astrPreferredDelivery - the preferred delivery.

setPreferredLanguage

public void setPreferredLanguage(java.lang.Integer anPreferredLanguage)
Sets the preferred language.
Specified by:
setPreferredLanguage in interface UserRegistrationCmd
Parameters:
anPreferredLanguage - the preferred language.

setPreferredLanguage

public void setPreferredLanguage(java.lang.String astrPreferredLanguage)
Sets the preferred language.
Specified by:
setPreferredLanguage in interface UserRegistrationCmd
Parameters:
astrPreferredLanguage - the preferred language.

setPreferredMeasure

public void setPreferredMeasure(java.lang.String astrPreferredMeasure)
Sets the preferred unit of measurement.
Specified by:
setPreferredMeasure in interface UserRegistrationCmd
Parameters:
astrPreferredMeasure - the preferred unit of measurement.

setPrimary

public void setPrimary(java.lang.Integer anPrimary)
Sets the primary address.
Specified by:
setPrimary in interface UserRegistrationCmd
Parameters:
anPrimary - the primary address.

setPrimary

public void setPrimary(java.lang.String astrPrimary)
Sets the primary address.
Specified by:
setPrimary in interface UserRegistrationCmd
Parameters:
astrPrimary - the primary address.

setProfileType

public void setProfileType(java.lang.String astrProfileType)
Sets the profile type.
Specified by:
setProfileType in interface UserRegistrationCmd
Parameters:
astrProfileType - the profile type.

setPublishPhone1

public void setPublishPhone1(java.lang.Integer anPublishPhone1)
Sets whether to publish the primary phone number.
Specified by:
setPublishPhone1 in interface UserRegistrationCmd
Parameters:
anPublishPhone1 - whether to publish the phone number.

setPublishPhone1

public void setPublishPhone1(java.lang.String astrPublishPhone1)
Sets whether to publish the primary phone number.
Specified by:
setPublishPhone1 in interface UserRegistrationCmd
Parameters:
astrPublishPhone1 - A string indicating whether or not publish phone 1 number
  • 1 - publish the phone 1 number
  • 0 - not publish the the phone 1 number

setPublishPhone2

public void setPublishPhone2(java.lang.Integer anPublishPhone2)
Sets whether to publish the secondary phone number.
Specified by:
setPublishPhone2 in interface UserRegistrationCmd
Parameters:
anPublishPhone2 - A integer indicating whether or not publish phone 2 number
  • 1 - publish the phone 2 number
  • 0 - not publish the the phone 2 number

setPublishPhone2

public void setPublishPhone2(java.lang.String astrPublishPhone2)
Sets whether to publish the secondary phone number.
Specified by:
setPublishPhone2 in interface UserRegistrationCmd
Parameters:
astrPublishPhone2 - A string indicating whether or not publish phone 2 number
  • 1 - publish the phone 2 number
  • 0 - not publish the the phone 2 number

setRequestProperties

public void setRequestProperties(TypedProperty reqProperties)
                          throws ECApplicationException
Sets the request properties.
Specified by:
setRequestProperties in interface ControllerCommand
Overrides:
setRequestProperties in class ControllerCommandImpl
Parameters:
reqProperties - the parameters passed to the command.
Throws:
ECApplicationException - if there was a problem procesing the request properties.

setSecretary

public void setSecretary(java.lang.String astrSecretary)
Sets the name of the admin assistant.
Specified by:
setSecretary in interface UserRegistrationCmd
Parameters:
astrSecretary - the name of the admin assistant.

setShippingGeoCode

public void setShippingGeoCode(java.lang.String astrShippingGeoCode)
Sets the shipping code.
Specified by:
setShippingGeoCode in interface UserRegistrationCmd
Parameters:
astrShippingGeoCode - the shipping code.

setState

public void setState(java.lang.String astrState)
Sets the state of user.
Specified by:
setState in interface UserRegistrationCmd
Parameters:
astrState - the state of the user.

setStatus

public void setStatus(java.lang.String astrStatus)
Sets the status of the user.
Specified by:
setStatus in interface UserRegistrationCmd
Parameters:
astrStatus - the status of the user.

setTaxGeoCode

public void setTaxGeoCode(java.lang.String astrTaxGeoCode)
Sets the tax geo code.
Specified by:
setTaxGeoCode in interface UserRegistrationCmd
Parameters:
astrTaxGeoCode - the tax code.

setTaxPayerId

public void setTaxPayerId(java.lang.String astrTaxPayerId)
Sets the tax payer identifier.
Specified by:
setTaxPayerId in interface UserRegistrationCmd
Parameters:
astrTaxPayerId - the tax payer identifier.

setTimeZone

public void setTimeZone(java.lang.String astrTimeZone)
Sets the time zone.
Specified by:
setTimeZone in interface UserRegistrationCmd
Parameters:
astrTimeZone - the time zone.

setURL

public void setURL(java.lang.String astrURL)
Sets the URL to go to after execution.
Specified by:
setURL in interface UserRegistrationCmd
Parameters:
astrURL - the URL to go to after executing.

setUserField1

public void setUserField1(java.lang.String astrUserField1)
Sets the user field 1.
Specified by:
setUserField1 in interface UserRegistrationCmd
Parameters:
astrUserField1 - the user field 1.

setUserField2

public void setUserField2(java.lang.String astrUserField2)
Sets the user field 1.
Specified by:
setUserField2 in interface UserRegistrationCmd
Parameters:
astrUserField2 - Customizable user field 2

setUserField3

public void setUserField3(java.lang.String astrUserField3)
Sets the user field 1.
Specified by:
setUserField3 in interface UserRegistrationCmd
Parameters:
astrUserField3 - Customizable user field 3

setUserProfileField1

public void setUserProfileField1(java.lang.String astrUserProfileField1)
Sets the user profile field 1.
Specified by:
setUserProfileField1 in interface UserRegistrationCmd
Parameters:
astrUserProfileField1 - Customerizable userprofile field 1

setUserProfileField2

public void setUserProfileField2(java.lang.String astrUserProfileField2)
Sets the user profile field 1.
Specified by:
setUserProfileField2 in interface UserRegistrationCmd
Parameters:
astrUserProfileField2 - Customerizable userprofile field 2

setUserStatus

public void setUserStatus(java.lang.Integer anUserStatus)
Sets the user status.
Specified by:
setUserStatus in interface UserRegistrationCmd
Parameters:
anUserStatus - the user status.

setUserStatus

public void setUserStatus(java.lang.String astrUserStatus)
Sets the user status.
Specified by:
setUserStatus in interface UserRegistrationCmd
Parameters:
astrUserStatus - The user's status.
  • 1 - enabled
  • 0 - disabled

setWorkingUserId

public void setWorkingUserId(java.lang.String astrUserId)
Sets the working user identifier.
Specified by:
setWorkingUserId in interface UserRegistrationCmd
Parameters:
astrUserId - the user identifier.

setZipCode

public void setZipCode(java.lang.String astrZipCode)
Sets the zip/postal code.
Specified by:
setZipCode in interface UserRegistrationCmd
Parameters:
astrZipCode - the zip/postal code.

UpdateCredentials

protected void UpdateCredentials(java.lang.String astrLogonId,
                                 java.lang.String astrLogonPassword)
                          throws ECException
Update the user's credentials.
Parameters:
astrLogonId - the logon id to update.
astrLogonPassword - the new logon password.
Throws:
ECException - If there is a problem updating credentials.

UpdatePreferredCurrency

protected void UpdatePreferredCurrency(java.lang.String astrPreferredCurrency)
                                throws ECException
Update the currency.
Parameters:
astrPreferredCurrency - the preferred curency.
Throws:
ECException

UpdatePreferredLanguage

protected void UpdatePreferredLanguage(java.lang.String astrPreferredLanguage)
                                throws ECException
Update the preferred language.
Parameters:
astrPreferredLanguage - the preferred language.
Throws:
ECException.
ECException

validateParameters

public void validateParameters()
                        throws ECException
Validates the parameters.
Specified by:
validateParameters in interface ECCommand
Overrides:
validateParameters in class AbstractECTargetableCommand
Throws:
ECException - If there are invalid or missing parameters.

getRequiredRolesForUser

protected java.util.Vector getRequiredRolesForUser(java.lang.Long user_id)
Get required roles for user.
Parameters:
user_id - the user id.

setRolesForMemberInOrg

protected void setRolesForMemberInOrg(java.lang.Long member_id,
                                      java.util.Vector roles_in_org)
                               throws ECException
Set roles for member in org.
Parameters:
member_id -
roles_in_org -
Throws:
ECException

logoffUserIfNotApproved

protected void logoffUserIfNotApproved(java.lang.String user_id)
Logoff user if not approved.
Parameters:
user_id -

checkAncestorsLocked

protected boolean checkAncestorsLocked(OrganizationAccessBean abOrgEntity)
                                throws ECException
Returns true if any parent organization is locked.
Returns:
boolean
Throws:
ECException