com.ibm.commerce.usermanagement.commands
Interface UserRegistrationCmd

All Superinterfaces:
AccCommand, ControllerCommand, ECCommand, Protectable
All Known Subinterfaces:
UserRegistrationAddCmd, UserRegistrationAddPreApprovalCmd, UserRegistrationAdminAddCmd, UserRegistrationAdminCmd, UserRegistrationAdminUpdateCmd, UserRegistrationUpdateCmd
All Known Implementing Classes:
UserRegistrationCmdImpl

public interface UserRegistrationCmd
extends ControllerCommand

The UserRegistrationCmd command is the base command for the following user registration commands:

It is not a URL command.


Field Summary
static java.lang.String COPYRIGHT
           
static java.lang.String NAME
           
 
Fields inherited from interface com.ibm.commerce.command.ECCommand
defaultCommandClassName
 
Method Summary
 java.lang.String getAddress1()
          Gets the first line of the address.
 java.lang.String getAddress2()
          Gets the second line of the address.
 java.lang.String getAddress3()
          Gets the third line of the address
 java.lang.String getAddressType()
          Gets the type of addresses.
 java.lang.String getAuthenticateMode()
          Gets the authenticate mode.
 java.lang.String getBestCallingTime()
          Gets the indicator for the best time to call the individual.
 java.lang.String getBillingCode()
          Gets the code to identify shipping/billing address for BPF.
 java.lang.String getBillingCodeType()
          Gets the code designating the system/method of code structure used for BACODE (for BPF).
 java.lang.String getBusinessTitle()
          Gets the business title of the person to which this address applies, eg.
 java.lang.String getCity()
          Gets the city name.
 java.lang.String getCountry()
          Gets the country name.
 java.sql.Timestamp getCreatedTimestamp()
          Gets the date and time when the address was created.
 java.lang.String getEmail1()
          Gets the e-mail or URL address 1 of the individual.
 java.lang.String getEmail2()
          Gets the e-mail or URL address 2 of the individual.
 java.lang.String getFax1()
          Gets the facsimile number 1 of the individual.
 java.lang.String getFax2()
          Gets the facsimile number 2 of the individual.
 java.lang.String getFirstName()
          Gets the first name of the individual.
 java.lang.String getLastName()
          Gets the last name of the individual.
 java.lang.String getMiddleName()
          Gets the middle name of the individual.
 java.lang.String getOfficeAddress()
          Gets the desktop delivery or office address associated with a shipping address.
 java.lang.String getOrganizationName()
          Gets the name of the organization to which this address informatoin applies if this is a business address.
 java.lang.String getOrganizationUnitName()
          Gets the name of the organizational unit to which this contact info applies if this is a business contact.
 java.lang.Integer getPackageSuppression()
          Gets the Package inserts suppression flag.
 java.lang.String getPersonTitle()
          Gets the title of the person to which this address applies.
 java.lang.String getPhone1()
          Gets the phone number 1.
 java.lang.String getPhone1Type()
          Gets the type of the phone 1.
 java.lang.String getPhone2()
          Gets the phone number 2.
 java.lang.String getPhone2Type()
          Gets the type of the phone 2.
 java.lang.Integer getPrimary()
          Gets a integer indicating whether the address is a primary address.
 java.lang.String getProfileType()
          Gets the profile type of the user.
 java.lang.Integer getPublishPhone1()
          Gets a integer indicating whether or not publish phone 1 number.
 java.lang.Integer getPublishPhone2()
          Gets a integer indicating whether or not publish phone 2 number.
 java.lang.String getState()
          Gets the name of the state, province, or equivalent where the individual resides.
 java.lang.String getStatus()
          Gets the temporary or permanent address, 'Permanent' really means 'current' address, 'Temporary' really means 'historical' address.
 java.lang.String getWorkingUserId()
          Gets the current userId the command is working on.
 java.lang.String getZipCode()
          Gets the zip code or equivalent postal code of the individual's adddres.
 void reset()
          Reset all instance variables of the command to initial state so it can be used again.
 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 the address.
 void setAddressField1(java.lang.String astrAddressField1)
          Sets the customizable address field 1.
 void setAddressField2(java.lang.String astrAddressField2)
          Sets the customizable address field 2.
 void setAddressField3(java.lang.String astrAddressField3)
          Sets the customizable address field 3.
 void setAddressType(java.lang.String astrAddressType)
          Sets the type of addresses.
 void setAge(java.lang.Integer anAge)
          Sets The age of the user.
 void setAge(java.lang.String astrAge)
          Sets The age of the user.
 void setAlternateId(java.lang.String astrAlternateId)
          Sets the special ID assigned by this business user's O or OU to this business user (eg.
 void setAuthenticateMode(java.lang.String astrAuthenticateMode)
          Sets the authenticate mode.
 void setBestCallingTime(java.lang.String astrBestCallingTime)
          Sets the indicator for the best time to call the individual.
 void setBillingCode(java.lang.String astrBillingCode)
          Sets the code to identify shipping/billing address for BPF.
 void setBillingCodeType(java.lang.String astrBillingCodeType)
          Sets the code designating the system/method of code structure used for BACODE (for BPF).
 void setBusinessTitle(java.lang.String astrBusinessTitle)
          Sets the business title of the person to which this address applies, eg.
 void setChallengeAnswer(java.lang.String astrAnswer)
          Sets the answer to the challenge question.
 void setChallengeQuestion(java.lang.String astrQuestion)
          Sets the challenge question for the user.
 void setChildren(java.lang.Integer anchildren)
          Sets number of children.
 void setChildren(java.lang.String astrchildren)
          Sets number of children.
 void setCity(java.lang.String astrCity)
          Sets the city name.
 void setCompanyName(java.lang.String astrCompanyName)
          Sets the name of the company for which the user works
 void setCountry(java.lang.String astrCountry)
          Sets the country name.
 void setCreatedTimestamp(java.sql.Timestamp atmCreatedTimestamp)
          Sets the date and time when the address was created.
 void setDemographicsField1(java.lang.String astrDemographicsField1)
          Sets the demographic field1 reserved for customization.
 void setDemographicsField2(java.lang.String astrDemographicsField2)
          Sets the demographic field2 reserved for customization.
 void setDemographicsField3(java.lang.String astrDemographicsField3)
          Sets the demographic field3 reserved for customization.
 void setDemographicsField4(java.lang.String astrDemographicsField4)
          Sets the demographic field4 reserved for customization.
 void setDemographicsField5(java.lang.String astrDemographicsField5)
          Sets the demographic field5 reserved for customization.
 void setDemographicsField6(java.lang.Integer anDemographicsField6)
          Sets the demographic field6 reserved for customization.
 void setDemographicsField6(java.lang.String astrDemographicsField6)
          Sets the demographic field6 reserved for customization.
 void setDemographicsField7(java.lang.String astrDemographicsField7)
          Sets the demographic field7 reserved for customization.
 void setDepartmentNumber(java.lang.String astrDepartmentNumber)
          Sets the department number where the member works (BUSPROF table).
 void setDescription(java.lang.String astrDescription)
          Sets the Description (USERPROF table).
 void setDisplayName(java.lang.String astrDisplayName)
          Sets the display name of the entry (USERPROF).
 void setDistinguishedName(java.lang.String astrDistinguishedName)
          Sets the distinguished name of the entry (USERS table).
 void setEmail1(java.lang.String astrEmail1)
          Sets the email or URL address 1 of the individual.
 void setEmail2(java.lang.String astrEmail2)
          Sets the email or URL address 2 of the individual.
 void setEmployeeId(java.lang.String astrEmployeeId)
          Sets the employee identification (BUSPROF table).
 void setEmployeeType(java.lang.String astrEmployeeType)
          Sets the employee type.
 void setEncipheredMerchantKey(java.lang.String strEncipheredMerchantKey)
          Sets the Enciphered Merchant Key to be used in the encryption of the password.
 void setFax1(java.lang.String astrFax1)
          Sets the facsimile number 1.
 void setFax2(java.lang.String astrFax1)
          Sets the facsimile number 2.
 void setFirstName(java.lang.String astrFirstName)
          Sets the first name of the individual.
 void setGender(java.lang.String astrGender)
          Sets the gender associated with this user.
 void setHobbies(java.lang.String astrHobbies)
          Sets the main interests and hobbies of this person.
 void setHousehold(java.lang.Integer anHousehold)
          Sets the number of people within the household of this user.
 void setHousehold(java.lang.String astrHousehold)
          Sets the number of people within the household of this person.
 void setIncome(java.lang.Integer anIncome)
          Sets the annual income category for this person.
 void setIncome(java.lang.String astrIncome)
          Sets the annual income category for this person.
 void setIncomeCurrency(java.lang.String astrIncomeCurrency)
          Sets the currency of income (USERDEMO table).
 void setLastName(java.lang.String astrLastName)
          Sets the last name of the individual.
 void setLogonId(java.lang.String astrLogonId)
          Sets the user's unique login Id.
 void setLogonPassword(java.lang.String astrLogonPassword)
          Sets the user's logon password.
 void setLogonPasswordVerify(java.lang.String astrLogonPasswordVerify)
          Sets the user's verify logon password.
 void setManager(java.lang.String astrManager)
          Sets business user's manager's name.
 void setMaritalStatus(java.lang.String astrMaritalStatus)
          Sets the Marital Status associated with this user.
 void setMerchantKey(java.lang.String strMerchantKey)
          Sets the Merchant Key to be used in the encryption of the password.
 void setMiddleName(java.lang.String astrMidName)
          Sets the middle name of the individual.
 void setOfficeAddress(java.lang.String astrOfficeAddress)
          Sets the office address.
 void setOrderBefore(java.lang.String astrOrderBefore)
          Sets the indicator of whether or not the user has previously placed an order.
 void setOrganizationId(java.lang.Long anOrganizationId)
          Sets the identifies the Organization to which this business profile is associated with (BUSPROF table).
 void setOrganizationId(java.lang.String astrOrganizationId)
          Sets the identifies the Organization to which this business profile is associated with (BUSPROF table).
 void setOrganizationName(java.lang.String astrOrganizationName)
          Sets the name of the organization to which this address informatoin applies if this is a business address.
 void setOrganizationUnitId(java.lang.Long anOrganizationUnitId)
          Sets the identifies the Organization Unit to which this business profile is associated with (BUSPROF table).
 void setOrganizationUnitId(java.lang.String astrOrganizationUnitId)
          Sets the identifies the Organization Unit to which this business profile is associated with (BUSPROF table).
 void setOrganizationUnitName(java.lang.String astrOrganizationUnitName)
          Sets the name of the organization unit to which this address informatoin applies if this is a business address.
 void setPackageSuppression(java.lang.Integer anPackageSuppression)
          Sets the Package inserts suppression flag.
 void setPackageSuppression(java.lang.String astrPackageSuppression)
          Sets the Package inserts suppression flag.
 void setPasswordExpired(java.lang.Integer anPasswordExpired)
          Sets the indicator Whether user password has expired
 void setPasswordExpired(java.lang.String astrPasswordExpired)
          Sets the indicator Whether user password has expired
 void setPersonTitle(java.lang.String astrPersonTitle)
          Sets the title of the person to which this address applies
 void setPhone1(java.lang.String astrPhone1)
          Sets the phone number 1.
 void setPhone1Type(java.lang.String astrPhone1Type)
          Sets the type of the phone 1
 void setPhone2(java.lang.String astrPhone2)
          Sets the phone number 2.
 void setPhone2Type(java.lang.String astrPhone2Type)
          Sets the type of the phone 2
 void setPhoto(java.lang.String astrPhoto)
          Sets the URL or path to the photo of the user.
 void setPreferredCommunication(java.lang.String astrPreferredCommunication)
          Sets the preferred method of communication.
 void setPreferredCurrency(java.lang.String astrPreferredCurrency)
          Sets the preferred currency in 3-character alphabetic code as per ISO 4217.
 void setPreferredDelivery(java.lang.String astrPreferredDelivery)
          Sets the preferred delivery method (USERPROF table).
 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 measurement system.
 void setPrimary(java.lang.Integer anPrimary)
          Sets a integer indicating whether the address is a primary address.
 void setPrimary(java.lang.String anPrimary)
          Sets a integer indicating whether the address is a primary address.
 void setProfileType(java.lang.String astrProfileType)
          Sets the profile type of the user.
 void setPublishPhone1(java.lang.Integer anPublishPhone1)
          Sets a integer indicating whether or not publish phone 1 number.
 void setPublishPhone1(java.lang.String astrPublishPhone1)
          Sets a string indicating whether or not publish phone 1 number.
 void setPublishPhone2(java.lang.Integer anPublishPhone2)
          Sets a integer indicating whether or not publish phone 2 number.
 void setPublishPhone2(java.lang.String astrPublishPhone2)
          Sets a string indicating whether or not publish phone 2 number.
 void setSecretary(java.lang.String astrSecretary)
          Sets business user's secretary's name
 void setShippingGeoCode(java.lang.String astrShippingGeoCode)
          Sets the shipping geographic code.
 void setState(java.lang.String astrState)
          Sets the name of the state, province, or equivalent where the individual resides.
 void setStatus(java.lang.String astrStatus)
          Sets the temporary or permanent address, 'Permanent' really means 'current' address, 'Temporary' really means 'historical' address.
 void setTaxGeoCode(java.lang.String astrTaxGeoCode)
          Sets the Tax geographic code.
 void setTaxPayerId(java.lang.String astrTaxPayerId)
          Set the tax payer id.
 void setTimeZone(java.lang.String astrTimeZone)
          Sets the time zone.
 void setURL(java.lang.String astrURL)
          Set the URL that is called when the command successfully completes.
 void setUserField1(java.lang.String astrUserField1)
          Sets user field 1 reserved for customization (USERS table).
 void setUserField2(java.lang.String astrUserField2)
          Sets user field 2 reserved for customization (USERS table).
 void setUserField3(java.lang.String astrUserField3)
          Sets user field 3 reserved for customization (USERS table).
 void setUserProfileField1(java.lang.String astrUserProfileField1)
          Sets userprofile field 1 reserved for customization (USERPROF table).
 void setUserProfileField2(java.lang.String astrUserProfileField2)
          Sets userprofile field 2 reserved for customization (USERPROF table).
 void setUserStatus(java.lang.Integer anUserStatus)
          Sets the user's status.
 void setUserStatus(java.lang.String astrUserStatus)
          Sets the user's status.
 void setWorkingUserId(java.lang.String astrUserId)
          Sets the current userId the command is working on.
 void setZipCode(java.lang.String astrZipCode)
          Sets the zip code or equivalent postal code of the individual's adddres.
 
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, getResources, getStoreId, getUser, getUserId, performExecute, setCommandContext, setCommandIfName, setDefaultProperties, validateParameters
 
Methods inherited from interface com.ibm.commerce.security.Protectable
fulfills, getOwner
 

Field Detail

COPYRIGHT

public static final java.lang.String COPYRIGHT

NAME

public static final java.lang.String NAME
Method Detail

getAddress1

public java.lang.String getAddress1()
Gets the first line of the address.
Returns:
The first line of the address

getAddress2

public java.lang.String getAddress2()
Gets the second line of the address.
Returns:
The second line of the address

getAddress3

public java.lang.String getAddress3()
Gets the third line of the address
Returns:
The third line of the address

getAddressType

public java.lang.String getAddressType()
Gets the type of addresses.
Returns:
The type of addresses For example:
  • SB - shipto and billto (default)
  • R - residential
  • M - mailing
  • B - billto
  • S - shipto

getAuthenticateMode

public java.lang.String getAuthenticateMode()
Gets the authenticate mode.
Returns:
The authenticate mode.
  • DB - use WCS Database to authenticate
  • LDAP - use LDAP server (such as IBM SecureWay) to authenticate

getBestCallingTime

public java.lang.String getBestCallingTime()
Gets the indicator for the best time to call the individual.
Returns:
The best time to call For example:
  • D - Daytime
  • E - Evening

getBillingCode

public java.lang.String getBillingCode()
Gets the code to identify shipping/billing address for BPF.
Returns:
The shipping billing code

getBillingCodeType

public java.lang.String getBillingCodeType()
Gets the code designating the system/method of code structure used for BACODE (for BPF).
Returns:
The shipping billing code type

getBusinessTitle

public java.lang.String getBusinessTitle()
Gets the business title of the person to which this address applies, eg. Manager, Vice President.
Returns:
The business title For example:
  • P - President
  • M - Manager

getCity

public java.lang.String getCity()
Gets the city name.
Returns:
The city name

getCountry

public java.lang.String getCountry()
Gets the country name.
Returns:
The country name

getCreatedTimestamp

public java.sql.Timestamp getCreatedTimestamp()
Gets the date and time when the address was created.
Returns:
The date and time when the address was created

getEmail1

public java.lang.String getEmail1()
Gets the e-mail or URL address 1 of the individual.
Returns:
The e-mail or URL address 1 of the individual

getEmail2

public java.lang.String getEmail2()
Gets the e-mail or URL address 2 of the individual.
Returns:
The e-mail or URL address 2 of the individual

getFax1

public java.lang.String getFax1()
Gets the facsimile number 1 of the individual.
Returns:
The facsimile number 1

getFax2

public java.lang.String getFax2()
Gets the facsimile number 2 of the individual.
Returns:
The facsimile number 2

getFirstName

public java.lang.String getFirstName()
Gets the first name of the individual.
Returns:
The first name

getLastName

public java.lang.String getLastName()
Gets the last name of the individual.
Returns:
The last name

getMiddleName

public java.lang.String getMiddleName()
Gets the middle name of the individual.
Returns:
The middle name

getOfficeAddress

public java.lang.String getOfficeAddress()
Gets the desktop delivery or office address associated with a shipping address. Note this is an internal address, eg. Office number etc. Not a full-blown address with street number, city, province/state, country, postal code, etc.
Returns:
The office address.

getOrganizationName

public java.lang.String getOrganizationName()
Gets the name of the organization to which this address informatoin applies if this is a business address.
Returns:
The name of the organization

getOrganizationUnitName

public java.lang.String getOrganizationUnitName()
Gets the name of the organizational unit to which this contact info applies if this is a business contact.
Returns:
The the name of the organizational unit.

getPackageSuppression

public java.lang.Integer getPackageSuppression()
Gets the Package inserts suppression flag.
Returns:
The package suppression flag
  • 1 - include
  • 0 - do not include

getPersonTitle

public java.lang.String getPersonTitle()
Gets the title of the person to which this address applies.
Returns:
The person title For example:
  • N - Not provided (default)
  • Mr - Mr.
  • Mrs - Mrs.
  • Ms - Ms.
  • Dr - Dr.
  • Prof- Prof.

getPhone1

public java.lang.String getPhone1()
Gets the phone number 1.
Returns:
the phone number 1

getPhone1Type

public java.lang.String getPhone1Type()
Gets the type of the phone 1.
Returns:
The type of phone1 For Example:
  • PHN - standard phone
  • TTY - teletypewriter for people who have a hearing impairment

getPhone2

public java.lang.String getPhone2()
Gets the phone number 2.
Returns:
the phone number 2

getPhone2Type

public java.lang.String getPhone2Type()
Gets the type of the phone 2.
Returns:
The type of phone2 For Example:
  • PHN - standard phone
  • TTY - teletypewriter for people who have a hearing impairment

getPrimary

public java.lang.Integer getPrimary()
Gets a integer indicating whether the address is a primary address. This allows multiple addresses for each address type. (eg. Multiple billing addresses, multiple shipto addresses) and one of them to be designated as the 'primary billing address', 'primary shipto address', etc. Each address type can have one or none primary address.
Returns:
A integer indicating whether the address is a primary address
  • 1 - primary (or default) address
  • 0 - not primary address

getProfileType

public java.lang.String getProfileType()
Gets the profile type of the user.
Returns:
The profile type of the user
  • C - Non-business user
  • B - Business user

getPublishPhone1

public java.lang.Integer getPublishPhone1()
Gets a integer indicating whether or not publish phone 1 number.
Returns:
A integer indicating whether or not publish phone 1 number
  • 1 - publish the phone 1 number
  • 0 - not publish the the phone 1 number

getPublishPhone2

public java.lang.Integer getPublishPhone2()
Gets a integer indicating whether or not publish phone 2 number.
Returns:
A integer indicating whether or not publish phone 2 number
  • 1 - publish the phone 2 number
  • 0 - not publish the the phone 2 number

getState

public java.lang.String getState()
Gets the name of the state, province, or equivalent where the individual resides.
Returns:
The name of the state

getStatus

public java.lang.String getStatus()
Gets the temporary or permanent address, 'Permanent' really means 'current' address, 'Temporary' really means 'historical' address. Each time a address is update, a new address will be created and the old address will become temporary address.
Returns:
The status of the address
  • P - permanent address
  • T - temporary address

getWorkingUserId

public java.lang.String getWorkingUserId()
Gets the current userId the command is working on. For UserRegistrationAdd/Upate, the working userId is the current userId in command context. For UserRegistrationAdminAdd/Update, the working userId is created/specified.
Returns:
The current userId the command is working on

getZipCode

public java.lang.String getZipCode()
Gets the zip code or equivalent postal code of the individual's adddres.
Returns:
The zip code

reset

public void reset()
Reset all instance variables of the command to initial state so it can be used again.

setAddress1

public void setAddress1(java.lang.String astrAddress1)
Sets the first line of the address.
Parameters:
astrAddress1 - The first line of the address

setAddress2

public void setAddress2(java.lang.String astrAddress2)
Sets the second line of the address.
Parameters:
astrAddress2 - The second line of the address

setAddress3

public void setAddress3(java.lang.String astrAddress3)
Sets the third line of the address.
Parameters:
astrAddress3 - The third line of the address

setAddressField1

public void setAddressField1(java.lang.String astrAddressField1)
Sets the customizable address field 1.
Parameters:
astrField1 - The customizable address field 1

setAddressField2

public void setAddressField2(java.lang.String astrAddressField2)
Sets the customizable address field 2.
Parameters:
astrField1 - The customizable address field 2

setAddressField3

public void setAddressField3(java.lang.String astrAddressField3)
Sets the customizable address field 3.
Parameters:
astrField1 - The customizable address field 3

setAddressType

public void setAddressType(java.lang.String astrAddressType)
Sets the type of addresses.
Parameters:
The - type of addresses For example:
  • R - residential
  • M - mailing
  • B - billto
  • S - shipto

setAge

public void setAge(java.lang.Integer anAge)
Sets The age of the user.
Parameters:
anAge - The age of the memeber For example:
  • 0 - Not provided (default),
  • 1 - 0-9 years,
  • 2 - 10-19 years,
  • 3 - 20-29 years,
  • 4 - 30-39 years,
  • 5 - 40-49 years,
  • 6 - 50-59 years,
  • 7 - 60 years or older

setAge

public void setAge(java.lang.String astrAge)
Sets The age of the user.
Parameters:
astrAge - The age of the memeber For example:
  • 0 - Not provided (default),
  • 1 - 0-9 years,
  • 2 - 10-19 years,
  • 3 - 20-29 years,
  • 4 - 30-39 years,
  • 5 - 40-49 years,
  • 6 - 50-59 years,
  • 7 - 60 years or older

setAlternateId

public void setAlternateId(java.lang.String astrAlternateId)
Sets the special ID assigned by this business user's O or OU to this business user (eg. the SBREQID in SHBTB table in BPF)
Parameters:
astrAlternateId - The special ID assigned by this business user's O or OU to this business user

setAuthenticateMode

public void setAuthenticateMode(java.lang.String astrAuthenticateMode)
Sets the authenticate mode.
Parameters:
astrAuthenticateMode - The authenticate mode.
  • DB - use WCS Database to authenticate
  • LDAP - use LDAP server (such as IBM SecureWay) to authenticate

setBestCallingTime

public void setBestCallingTime(java.lang.String astrBestCallingTime)
Sets the indicator for the best time to call the individual.
Parameters:
astrBestCallingTime - The best calling time For example:
  • D - Daytime
  • E - Evening

setBillingCode

public void setBillingCode(java.lang.String astrBillingCode)
Sets the code to identify shipping/billing address for BPF.
Parameters:
astrBillingCode - The shipping billing code

setBillingCodeType

public void setBillingCodeType(java.lang.String astrBillingCodeType)
Sets the code designating the system/method of code structure used for BACODE (for BPF).
Parameters:
astrBillingCodeType - The shipping billing code type

setBusinessTitle

public void setBusinessTitle(java.lang.String astrBusinessTitle)
Sets the business title of the person to which this address applies, eg. Manager, Vice President.
Parameters:
astrBusinessTitle - The business title For example:
  • P - President
  • M - Manager

setChallengeAnswer

public void setChallengeAnswer(java.lang.String astrAnswer)
Sets the answer to the challenge question.
Parameters:
astrAnswer - The answer to the challenge question

setChallengeQuestion

public void setChallengeQuestion(java.lang.String astrQuestion)
Sets the challenge question for the user.
Parameters:
astrQuestion - The challenge question

setChildren

public void setChildren(java.lang.Integer anchildren)
Sets number of children.
Parameters:
anchildren - The number of children

setChildren

public void setChildren(java.lang.String astrchildren)
Sets number of children.
Parameters:
anchildren - The number of children

setCity

public void setCity(java.lang.String astrCity)
Sets the city name.
Parameters:
astrCity - The city name

setCompanyName

public void setCompanyName(java.lang.String astrCompanyName)
Sets the name of the company for which the user works
Parameters:
astrCompanyName - The name of the company

setCountry

public void setCountry(java.lang.String astrCountry)
Sets the country name.
Parameters:
astrCountry - The country name

setCreatedTimestamp

public void setCreatedTimestamp(java.sql.Timestamp atmCreatedTimestamp)
Sets the date and time when the address was created.
Parameters:
atmCreatedTimestamp - The date and time when the address was created

setDemographicsField1

public void setDemographicsField1(java.lang.String astrDemographicsField1)
Sets the demographic field1 reserved for customization.
Parameters:
astrDemographicsField1 - The demographic field1 reserved for customization

setDemographicsField2

public void setDemographicsField2(java.lang.String astrDemographicsField2)
Sets the demographic field2 reserved for customization.
Parameters:
astrDemographicsField2 - The demographic field2 reserved for customization

setDemographicsField3

public void setDemographicsField3(java.lang.String astrDemographicsField3)
Sets the demographic field3 reserved for customization.
Parameters:
astrDemographicsField3 - The demographic field3 reserved for customization

setDemographicsField4

public void setDemographicsField4(java.lang.String astrDemographicsField4)
Sets the demographic field4 reserved for customization.
Parameters:
astrDemographicsField4 - The demographic field4 reserved for customization

setDemographicsField5

public void setDemographicsField5(java.lang.String astrDemographicsField5)
Sets the demographic field5 reserved for customization.
Parameters:
astrDemographicsField5 - Thedemographic field5 reserved for customization

setDemographicsField6

public void setDemographicsField6(java.lang.Integer anDemographicsField6)
Sets the demographic field6 reserved for customization.
Parameters:
anDemographicsField6 - The demographic field6 reserved for customization

setDemographicsField6

public void setDemographicsField6(java.lang.String astrDemographicsField6)
Sets the demographic field6 reserved for customization.
Parameters:
astrDemographicsField6 - The demographic field6 reserved for customization

setDemographicsField7

public void setDemographicsField7(java.lang.String astrDemographicsField7)
Sets the demographic field7 reserved for customization.
Parameters:
astrDemographicsField7 - The demographic field7 reserved for customization

setDepartmentNumber

public void setDepartmentNumber(java.lang.String astrDepartmentNumber)
Sets the department number where the member works (BUSPROF table).
Parameters:
astrDepartmentNumber - The department number where the member works

setDescription

public void setDescription(java.lang.String astrDescription)
Sets the Description (USERPROF table). LDAP has a description attribute for various person type of objects, and o/ou, and groupOfNames
Parameters:
astrDescription - The Description

setDisplayName

public void setDisplayName(java.lang.String astrDisplayName)
Sets the display name of the entry (USERPROF). A name used in displaying an entry in a one line summary list. This is the displayName attribute from ePerson auxiliary class in LDAP.
Parameters:
astrDisplayName - The display name of the entry

setDistinguishedName

public void setDistinguishedName(java.lang.String astrDistinguishedName)
Sets the distinguished name of the entry (USERS table). Used for coordination with LDAP.
Parameters:
astrRegistrationType - The distinguished name of the entry

setEmail1

public void setEmail1(java.lang.String astrEmail1)
Sets the email or URL address 1 of the individual.
Parameters:
astrEmail1 - The email or URL address 1

setEmail2

public void setEmail2(java.lang.String astrEmail2)
Sets the email or URL address 2 of the individual.
Parameters:
astrEmail2 - The email or URL address 2

setEmployeeId

public void setEmployeeId(java.lang.String astrEmployeeId)
Sets the employee identification (BUSPROF table).
Parameters:
astrEmployeeId - The employee identification

setEmployeeType

public void setEmployeeType(java.lang.String astrEmployeeType)
Sets the employee type. Such as regular, partime, special partime.
Parameters:
astrEmployeeType - The employee type

setEncipheredMerchantKey

public void setEncipheredMerchantKey(java.lang.String strEncipheredMerchantKey)
Sets the Enciphered Merchant Key to be used in the encryption of the password. This command task will implicitly decrypt the enciphered Merchant Key.
Parameters:
strEncipheredMerchantKey - The Enciphered Merchant Key.

setFax1

public void setFax1(java.lang.String astrFax1)
Sets the facsimile number 1.
Parameters:
astrFax1 - The facsimile number 1

setFax2

public void setFax2(java.lang.String astrFax1)
Sets the facsimile number 2.
Parameters:
astrFax1 - The facsimile number 2

setFirstName

public void setFirstName(java.lang.String astrFirstName)
Sets the first name of the individual.
Parameters:
astrFirstName - The first name

setGender

public void setGender(java.lang.String astrGender)
Sets the gender associated with this user.
Parameters:
astrGender - The gender associated with this user For example:
  • N - Not provided (default)
  • F - Female
  • M - Male

setHobbies

public void setHobbies(java.lang.String astrHobbies)
Sets the main interests and hobbies of this person.
Parameters:
astrInterests - The main intests and hobbies of this person

setHousehold

public void setHousehold(java.lang.Integer anHousehold)
Sets the number of people within the household of this user.
Parameters:
anHouseHold - The number of people within the household

setHousehold

public void setHousehold(java.lang.String astrHousehold)
Sets the number of people within the household of this person.
Parameters:
anHouseHold - The number of people within the household.

setIncome

public void setIncome(java.lang.Integer anIncome)
Sets the annual income category for this person.
Parameters:
anIncome - The annual income category for this person For example:
  • 0 - Not provided (default)
  • 1 - $0 - $19,999
  • 2 - $20,000 - $39,999
  • 3 - $40,000 - $59,999
  • 4 - $60,000 or more

setIncome

public void setIncome(java.lang.String astrIncome)
Sets the annual income category for this person.
Parameters:
astrIncome - The annual income category for this person. For example:
  • 0 - Not provided (default)
  • 1 - $0 - $19,999
  • 2 - $20,000 - $39,999
  • 3 - $40,000 - $59,999
  • 4 - $60,000 or more

setIncomeCurrency

public void setIncomeCurrency(java.lang.String astrIncomeCurrency)
Sets the currency of income (USERDEMO table).
Parameters:
astrIncomeCurrency - The currency of income

setLastName

public void setLastName(java.lang.String astrLastName)
Sets the last name of the individual.
Parameters:
astrLastName - The last name

setLogonId

public void setLogonId(java.lang.String astrLogonId)
Sets the user's unique login Id. The Id can only contain alphanumeric characters or the symbols '@' and '.'.
Parameters:
astrLogonId - The user's login Id

setLogonPassword

public void setLogonPassword(java.lang.String astrLogonPassword)
Sets the user's logon password.
Parameters:
astrLogonPassword - The logon password

setLogonPasswordVerify

public void setLogonPasswordVerify(java.lang.String astrLogonPasswordVerify)
Sets the user's verify logon password.
Parameters:
astrLogonPasswordVerify - The user's verify logon password

setManager

public void setManager(java.lang.String astrManager)
Sets business user's manager's name.
Parameters:
astrManager - The name of manager

setMaritalStatus

public void setMaritalStatus(java.lang.String astrMaritalStatus)
Sets the Marital Status associated with this user.
Parameters:
astrMaritalStatus - The marital status value For example:
  • S - Single
  • M - Married
  • C - Common Law
  • P - Separated
  • D - Divorced
  • W - Widowed
  • O - Other
  • N - Not Provided

setMerchantKey

public void setMerchantKey(java.lang.String strMerchantKey)
Sets the Merchant Key to be used in the encryption of the password.
Parameters:
strMerchantKey - The Merchant Key.

setMiddleName

public void setMiddleName(java.lang.String astrMidName)
Sets the middle name of the individual.
Parameters:
astrMiddleName - The middle name

setOfficeAddress

public void setOfficeAddress(java.lang.String astrOfficeAddress)
Sets the office address.
Parameters:
astrOfficeAddress - The office address

setOrderBefore

public void setOrderBefore(java.lang.String astrOrderBefore)
Sets the indicator of whether or not the user has previously placed an order. Supplied by the user.
Parameters:
astrOrderBefore - The indicator of whether or not the user has previously placed an order

setOrganizationId

public void setOrganizationId(java.lang.Long anOrganizationId)
Sets the identifies the Organization to which this business profile is associated with (BUSPROF table). Foreign key to the ORGENTITY table.
Parameters:
anOrganizationId - The identifies the Organization to which this business profile is associated with

setOrganizationId

public void setOrganizationId(java.lang.String astrOrganizationId)
Sets the identifies the Organization to which this business profile is associated with (BUSPROF table). Foreign key to the ORGENTITY table.
Parameters:
astrOrganizationId - The identifies the Organization to which this business profile is associated with

setOrganizationName

public void setOrganizationName(java.lang.String astrOrganizationName)
Sets the name of the organization to which this address informatoin applies if this is a business address.
Parameters:
astrOrganizationName - The name of the organization

setOrganizationUnitId

public void setOrganizationUnitId(java.lang.Long anOrganizationUnitId)
Sets the identifies the Organization Unit to which this business profile is associated with (BUSPROF table). Foreign key to the ORGENTITY table.
Parameters:
anOrganizationUnitId - The identifies the Organization Unit to which this business profile is associated with

setOrganizationUnitId

public void setOrganizationUnitId(java.lang.String astrOrganizationUnitId)
Sets the identifies the Organization Unit to which this business profile is associated with (BUSPROF table). Foreign key to the ORGENTITY table.
Parameters:
astrOrganizationUnitId - The identifies the Organization Unit to which this business profile is associated with

setOrganizationUnitName

public void setOrganizationUnitName(java.lang.String astrOrganizationUnitName)
Sets the name of the organization unit to which this address informatoin applies if this is a business address.
Parameters:
astrOrganizationUnitName - The name of the organization unit

setPackageSuppression

public void setPackageSuppression(java.lang.Integer anPackageSuppression)
Sets the Package inserts suppression flag.
Parameters:
anPackageSuppression - The package suppression flag
  • 1 - include
  • 0 - do not include

setPackageSuppression

public void setPackageSuppression(java.lang.String astrPackageSuppression)
Sets the Package inserts suppression flag.
Parameters:
astrPackageSuppression - The package suppression flag
  • 1 - include
  • 0 - do not include

setPasswordExpired

public void setPasswordExpired(java.lang.Integer anPasswordExpired)
Sets the indicator Whether user password has expired
Parameters:
newIstrPasswordExpired - The indicator Whether user password has expired
  • 0 - not expired
  • 1 - expired

setPasswordExpired

public void setPasswordExpired(java.lang.String astrPasswordExpired)
Sets the indicator Whether user password has expired
Parameters:
newIstrPasswordExpired - The indicator Whether user password has expired
  • 0 - not expired
  • 1 - expired

setPersonTitle

public void setPersonTitle(java.lang.String astrPersonTitle)
Sets the title of the person to which this address applies
Parameters:
astrPersonTitle - The person title
  • N - Not provided (default)
  • Mr.
  • Mrs.
  • Ms.
  • Dr.
  • Prof.
  • Rev.

setPhone1

public void setPhone1(java.lang.String astrPhone1)
Sets the phone number 1.
Parameters:
astrPhone1 - The phone number 1

setPhone1Type

public void setPhone1Type(java.lang.String astrPhone1Type)
Sets the type of the phone 1
Parameters:
astrPhone1Type - The type of phone1
  • PHN - standard phone
  • TTY - teletypewriter for people who have a hearing impairment

setPhone2

public void setPhone2(java.lang.String astrPhone2)
Sets the phone number 2.
Parameters:
astrPhone2 - The phone number 2

setPhone2Type

public void setPhone2Type(java.lang.String astrPhone2Type)
Sets the type of the phone 2
Parameters:
astrPhone2Type - The type of phone 2
  • PHN - standard phone
  • TTY - teletypewriter for people who have a hearing impairment

setPhoto

public void setPhoto(java.lang.String astrPhoto)
Sets the URL or path to the photo of the user.
Parameters:
astrPhoto - The URL or path to the photo of the user

setPreferredCommunication

public void setPreferredCommunication(java.lang.String astrPreferredCommunication)
Sets the preferred method of communication.
Parameters:
astrPreferredCommunication - The preferred method of communication

setPreferredCurrency

public void setPreferredCurrency(java.lang.String astrPreferredCurrency)
Sets the preferred currency in 3-character alphabetic code as per ISO 4217. Foreign key to SETCURR table.
Parameters:
astrPreferredCurrency - The preferred currency

setPreferredDelivery

public void setPreferredDelivery(java.lang.String astrPreferredDelivery)
Sets the preferred delivery method (USERPROF table).
Parameters:
astrPreferredDelivery - The preferred delivery method.

setPreferredLanguage

public void setPreferredLanguage(java.lang.Integer anPreferredLanguage)
Sets the preferred language. Foreign key relationship to LANGUAGE table.
Parameters:
anPreferredLanguage - The preferred language

setPreferredLanguage

public void setPreferredLanguage(java.lang.String astrPreferredLanguage)
Sets the preferred language. Foreign key relationship to LANGUAGE table.
Parameters:
astrPreferredLanguage - The preferred language

setPreferredMeasure

public void setPreferredMeasure(java.lang.String astrPreferredMeasure)
Sets the preferred measurement system.
Parameters:
astrPreferredMeasure - The preferred measurement system

setPrimary

public void setPrimary(java.lang.Integer anPrimary)
Sets a integer indicating whether the address is a primary address. This allows multiple addresses for each address type (eg. Multiple billing addresses, multiple shipto addresses) and one of them to be designated as the 'primary billing address', 'primary shipto address', etc. Each address type can have one or none primary address.
Parameters:
anPrimary - A integer indicating whether the address is a primary address
  • 1 - primary (or default) address
  • 0 - not primary address

setPrimary

public void setPrimary(java.lang.String anPrimary)
Sets a integer indicating whether the address is a primary address. This allows multiple addresses for each address type (eg. Multiple billing addresses, multiple shipto addresses) and one of them to be designated as the 'primary billing address', 'primary shipto address', etc. Each address type can have one or none primary address.
Parameters:
anPrimary - A String indicating whether the address is a primary address
  • 1 - primary (or default) address
  • 0 - not primary address

setProfileType

public void setProfileType(java.lang.String astrProfileType)
Sets the profile type of the user.
Parameters:
astrProfileType - The profile type of the user
  • C - Non-business user
  • B - Business user

setPublishPhone1

public void setPublishPhone1(java.lang.Integer anPublishPhone1)
Sets a integer indicating whether or not publish phone 1 number.
Parameters:
anPublishPhone1 - A integer indicating whether or not publish phone 1 number
  • 1 - publish the phone 1 number
  • 0 - not publish the the phone 1 number

setPublishPhone1

public void setPublishPhone1(java.lang.String astrPublishPhone1)
Sets a string indicating whether or not publish phone 1 number.
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 a integer indicating whether or not publish phone 2 number.
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 a string indicating whether or not publish phone 2 number.
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

setSecretary

public void setSecretary(java.lang.String astrSecretary)
Sets business user's secretary's name
Parameters:
astrSecretary - The name of the secretary

setShippingGeoCode

public void setShippingGeoCode(java.lang.String astrShippingGeoCode)
Sets the shipping geographic code.
Parameters:
astrShippingGeoCode -  

setState

public void setState(java.lang.String astrState)
Sets the name of the state, province, or equivalent where the individual resides.
Parameters:
astrState - The name of the state

setStatus

public void setStatus(java.lang.String astrStatus)
Sets the temporary or permanent address, 'Permanent' really means 'current' address, 'Temporary' really means 'historical' address.
Parameters:
astrStatus - The status of the address
  • P - permanent address
  • T - temporary address

setTaxGeoCode

public void setTaxGeoCode(java.lang.String astrTaxGeoCode)
Sets the Tax geographic code.
Parameters:
astrTaxGeoCode -  

setTaxPayerId

public void setTaxPayerId(java.lang.String astrTaxPayerId)
Set the tax payer id.
Parameters:
astrTaxPayerId - The tax payer id

setTimeZone

public void setTimeZone(java.lang.String astrTimeZone)
Sets the time zone.
Parameters:
astrTimeZone - The time zone

setURL

public void setURL(java.lang.String astrURL)
Set the URL that is called when the command successfully completes.
Parameters:
astrURL - The URL

setUserField1

public void setUserField1(java.lang.String astrUserField1)
Sets user field 1 reserved for customization (USERS table).
Parameters:
astrUserField1 - Customizable user field 1

setUserField2

public void setUserField2(java.lang.String astrUserField2)
Sets user field 2 reserved for customization (USERS table).
Parameters:
astrUserField2 - Customizable user field 2

setUserField3

public void setUserField3(java.lang.String astrUserField3)
Sets user field 3 reserved for customization (USERS table).
Parameters:
astrUserField3 - Customizable user field 3

setUserProfileField1

public void setUserProfileField1(java.lang.String astrUserProfileField1)
Sets userprofile field 1 reserved for customization (USERPROF table).
Parameters:
astrUserProfileField1 - Customerizable userprofile field 1

setUserProfileField2

public void setUserProfileField2(java.lang.String astrUserProfileField2)
Sets userprofile field 2 reserved for customization (USERPROF table).
Parameters:
astrUserProfileField2 - Customerizable userprofile field 2

setUserStatus

public void setUserStatus(java.lang.Integer anUserStatus)
Sets the user's status. This allows adminstrator to disable/enable a user's LogonId without removing the user from the system.
Parameters:
anUserStatus - The user's status.
  • 1 - enabled
  • 0 - disabled

setUserStatus

public void setUserStatus(java.lang.String astrUserStatus)
Sets the user's status. This allows adminstrator to disable/enable a user's LogonId without removing the user from the system.
Parameters:
astrUserStatus - The user's status.
  • 1 - enabled
  • 0 - disabled

setWorkingUserId

public void setWorkingUserId(java.lang.String astrUserId)
Sets the current userId the command is working on.
Parameters:
astrUserId - The current userId the command is working on

setZipCode

public void setZipCode(java.lang.String astrZipCode)
Sets the zip code or equivalent postal code of the individual's adddres.
Parameters:
astrZipCode - The zip code