com.ibm.commerce.user.beans

Class UserRegistrationDataBean

  • java.lang.Object
    • com.ibm.commerce.user.beans.UserRegistrationDataBean
  • All Implemented Interfaces:
    DataBean, InputDataBean, SmartDataBean, Delegator, com.ibm.commerce.user.beans.UserRegistrationInputDataBean, com.ibm.commerce.user.beans.UserRegistrationSmartDataBean, java.io.Serializable


    public class UserRegistrationDataBean
    extends java.lang.Object
    implements com.ibm.commerce.user.beans.UserRegistrationInputDataBean, com.ibm.commerce.user.beans.UserRegistrationSmartDataBean, Delegator
    The data bean representing the registration information of a user. Use of this data bean will synchronize the data with the LDAP server if they system is configured to work with LDAP. This data bean should only be used for a registered user. The data bean to use with guest users is UserDataBean.

    The following code can be used to create and active a UserRegistrationDataBean:

     UserRegistrationDataBean bnRegister = new UserRegistrationDataBean();
     com.ibm.commerce.beans.DataBeanManager.activate(bnRegister, request);
     
    The UserRegisrationDataBean will automatically get userId from commandContext. Users can also call setUserId(Long) or setUserId(String) to set the userId directly to overwrite the userId get from commandContext:
     UserRegistrationDataBean bnRegister = new UserRegistrationDataBean();
      bnRegister.setUserId(istrUserId);
     com.ibm.commerce.beans.DataBeanManager.activate(bnRegister, request);
     
    If the specified user is found, the findUser() method will return true, otherwise return false.
    See Also:
    Serialized Form
    • Method Summary

      All Methods Instance Methods Concrete Methods Deprecated Methods 
      Modifier and Type Method and Description
      boolean findUser()
      Returns a boolean value indicating whether the user is found according to the specified userId.
      AddressAccessBean getAddress()
      Return the register address (User's own address).
      java.lang.String getAddress1()
      Gets the first line of the address.
      java.lang.String getAddress1URL()
      Gets the name of Address1 url parameter.
      java.lang.String getAddress2()
      Gets the second line of the address.
      java.lang.String getAddress2URL()
      Gets the name of Address2 url parameter.
      java.lang.String getAddress3()
      Gets the third line of the address.
      java.lang.String getAddress3URL()
      Gets the name of Address3 url parameter.
      AddressBookAccessBean getAddressBook()
      Gets the AddressBookAccessBean of this member.
      java.util.ArrayList getAddressesForUser()
      Get the addresses for this user.
      java.lang.String getAddressField1()
      Gets the customizable address field 1.
      java.lang.String getAddressField1URL()
      Gets the name of Address3 url parameter.
      java.lang.String getAddressField2()
      Gets the customizable address field 2.
      java.lang.String getAddressField2URL()
      Gets the name of Address3 url parameter.
      java.lang.String getAddressField3()
      Gets the customizable address field 3.
      java.lang.String getAddressField3URL()
      Gets the name of Address3 url parameter.
      java.lang.String getAddressId()
      Gets the address id for this registration address.
      java.lang.String getAddressIdURL()
      Gets the name of AddressId url parameter.
      java.lang.String getAddressType()
      Gets the address type for this registration address.
      java.lang.String getAddressTypeURL()
      Gets the name of AddressType url parameter.
      java.lang.String getAge()
      Gets an integer which indicates the age of the user.
      java.lang.String getAgeURL()
      Gets the name of Age url parameter.
      java.lang.String getAlternateId()
      Gets the special ID assigned by this business user's O or OU to this business user .
      java.lang.String getAlternateIdURL()
      Gets the name of AlternateId url parameter.
      java.lang.Long[] getAncestors()
      Get a list of all ancestor orgentities of this user.
      java.lang.String getAttribute(java.lang.String astrAttributeName)
      Gets attribute value according to the specified attribute name.
      java.util.Vector getAttribute(java.lang.String astrAttributeName, java.lang.String astrStoreEntityId)
      Gets the Vector which contains values of the multiple-valued or context-based attribute according to the specified attribute name and optional StoreEntityId.
      TypedProperty getAttributes()
      Gets the TypedProperty which contains all attributes for this user.
      java.lang.String getBestCallingTime()
      Gets the indicator for the best time to call the individual.
      java.lang.String getBestCallingTimeURL()
      Gets the name of BestCallingTime url parameter.
      java.lang.String getBillingCode()
      Gets the indicator for the best time to call the individual.
      java.lang.String getBillingCodeType()
      Gets the indicator for the best time to call the individual.
      java.lang.String getBillingCodeTypeURL()
      Gets the name of BillingCodeType url parameter.
      java.lang.String getBillingCodeURL()
      Gets the name of BillingCode url parameter.
      java.lang.String getBusinessTitle()
      Gets the business title of the person to which this address applies, eg.
      java.lang.String getBusinessTitleURL()
      Gets the name of BusinessTitle url parameter.
      java.lang.String getChallengeAnswer()
      Gets the answer to the challenge question.
      java.lang.String getChallengeAnswerURL()
      Gets the name of ChallengeAnswer url parameter.
      java.lang.String getChallengeQuestion()
      Gets the challenge question for the user.
      java.lang.String getChallengeQuestionURL()
      Gets the name of ChallengeQuestion url parameter.
      java.lang.String getChildrenURL()
      Gets the name of Children url parameter.
      java.lang.String getCity()
      Gets the city name.
      java.lang.String getCityURL()
      Gets the name of City url parameter.
      CommandContext getCommandContext()
      Gets the command context.
      java.lang.String getCompanyName()
      Gets the name of the company for which the user works
      java.lang.String getCompanyNameURL()
      Gets the name of CompanyName url parameter.
      java.lang.String getCountry()
      Gets the country name.
      java.lang.String getCountryURL()
      Gets the name of Country url parameter.
      java.lang.String[][] getCurrencyList()
      Return a two dimension String array which contains all currency information in the SETCURR table.
      java.lang.String getDataBeanKeyMemberId()
      Gets the user Id.
      java.lang.String getDateOfBirth()
      Gets the date of birth of this person.
      java.lang.String getDateOfBirthURL()
      Gets the name of DateOfBirth URL parameter.
      Protectable getDelegate()
      getDelegate method comment.
      java.lang.String getDemoField1URL()
      Gets the name of DemoField1 url parameter.
      java.lang.String getDemoField2URL()
      Gets the name of DemoField2 url parameter.
      java.lang.String getDemoField3URL()
      Gets the name of DemoField3 url parameter.
      java.lang.String getDemoField4URL()
      Gets the name of DemoField4 url parameter.
      java.lang.String getDemoField5URL()
      Gets the name of DemoField5 url parameter.
      java.lang.String getDemoField6URL()
      Gets the name of DemoField6 url parameter.
      java.lang.String getDemoField7URL()
      Gets the name of DemoField7 url parameter.
      java.lang.String getDemographicField1()
      Gets the demographic field1 reserved for customization.
      java.lang.String getDemographicField2()
      Gets the demographic field2 reserved for customization.
      java.lang.String getDemographicField3()
      Gets the demographic field3 reserved for customization.
      java.lang.String getDemographicField4()
      Gets the demographic field4 reserved for customization.
      java.lang.String getDemographicField5()
      Gets the demographic field5 reserved for customization.
      java.lang.String getDemographicField6()
      Gets the demographic field6 reserved for customization.
      java.lang.String getDemographicField7()
      Gets the demographic field7 reserved for customization.
      DemographicsAccessBean getDemographics()
      Gets the DemographicsAccessBean of this member.
      java.lang.String getDemographicsField1()
      Deprecated. 
      in version 6.0. Use getDemographicField1() instead.
      java.lang.String getDemographicsField2()
      Deprecated. 
      in version 6.0. Use getDemographicField2() instead.
      java.lang.String getDemographicsField3()
      Deprecated. 
      in version 6.0. Use getDemographicField3() instead.
      java.lang.String getDemographicsField4()
      Deprecated. 
      in version 6.0. Use getDemographicField4() instead.
      java.lang.String getDemographicsField5()
      Deprecated. 
      in version 6.0. Use getDemographicField5() instead.
      java.lang.String getDemographicsField6()
      Deprecated. 
      in version 6.0. Use getDemographicField6() instead.
      java.lang.String getDemographicsField7()
      Deprecated. 
      in version 6.0. Use getDemographicField7() instead.
      java.lang.String getDepartmentNumber()
      Gets the department number where the member works (BUSPROF table).
      java.lang.String getDepartmentNumberURL()
      Gets the name of DepartmentNumber url parameter.
      java.lang.String getDescription()
      Gets the Description (USERPROF table).
      java.lang.String getDescriptionURL()
      Gets the name of Description url parameter.
      java.lang.String getDisplayName()
      Gets the display name of the entry (USERPROF).
      java.lang.String getDisplayNameURL()
      Gets the name of DisplayName url parameter.
      java.lang.String getDistinguishedName()
      Sets the distinguished name of the entry (USERS table).
      java.lang.String getDistinguishedNameURL()
      Gets the name of DistinguishedName url parameter.
      java.lang.String getEmail1()
      Gets the e-mail or URL address 1 of the individual.
      java.lang.String getEmail1URL()
      Gets the name of Email1 URL parameter.
      java.lang.String getEmail2()
      Gets the e-mail or URL address 2 of the individual.
      java.lang.String getEmail2URL()
      Gets the name of Email2 URL parameter.
      java.lang.String getEmployeeId()
      Gets the employee identification (BUSPROF table).
      java.lang.String getEmployeeIdURL()
      Gets the name of EmployeeId URL parameter.
      java.lang.String getEmployeeType()
      Gets the employee type.
      java.lang.String getEmployeeTypeURL()
      Gets the name of EmployeeType URL parameter.
      java.lang.String getFax1()
      Gets the facsimile number 1 of the individual.
      java.lang.String getFax1URL()
      Gets the name of Fax1 URL parameter.
      java.lang.String getFax2()
      Gets the facsimile number 2 of the individual.
      java.lang.String getFax2URL()
      Gets the name of Fax2 URL parameter.
      java.lang.String getFirstName()
      Gets the first name of the individual.
      java.lang.String getFirstNameURL()
      Gets the name of FirstName URL parameter.
      java.lang.String getGender()
      Gets the gender associated with this user.
      java.lang.String getGenderURL()
      Gets the name of Gender URL parameter.
      java.lang.String getHobbies()
      Gets the main interests and hobbies of this person.
      java.lang.String getHobbiesURL()
      Gets the name of Hobbies URL parameter.
      java.lang.String getHousehold()
      Gets the number of people within the household of this user.
      java.lang.String getHouseholdURL()
      Gets the name of Household URL parameter.
      java.lang.String getIncome()
      Gets the annual income category for this person.
      java.lang.String getIncomeURL()
      Gets the name of Income URL parameter.
      java.lang.String[][] getLanguageList()
      Return a two dimension String array which contains all language information in the LANGUAGE and LANGUAGEDS tables.
      java.lang.String getLastName()
      Gets the last name of the individual.
      java.lang.String getLastNameURL()
      Gets the name of LastName URL parameter.
      java.lang.String getLastOrder()
      Get the data and time when last order happened.
      java.lang.String getLastOrderTime()
      Get the data and time when last order happened.
      java.lang.String getLastOrderTimeURL()
      Gets the name of LastName URL parameter.
      java.lang.String getLastSession()
      Get the data and time of user session.
      java.lang.String getLastSessionURL()
      Gets the name of LastSession URL parameter.
      java.lang.String getLogonId()
      Gets the user's unique login Id.
      java.lang.String getLogonIdURL()
      Gets the name of LogonId URL parameter.
      java.lang.String getLogonPassword()
      Gets the user's logon password (encrypted).
      java.lang.String getLogonPasswordURL()
      Gets the name of LogonPassword URL parameter.
      java.lang.String getLogonPasswordVerifyURL()
      Gets the name of LogonPasswordVerify URL parameter.
      java.lang.String getManager()
      Gets business user's manager's name.
      java.lang.String getManagerURL()
      Gets the name of Manager URL parameter.
      java.lang.String getMaritalStatus()
      Gets the Marital Status associated with this user.
      java.lang.String getMaritalStatusURL()
      Gets the name of MaritalStatus URL parameter.
      java.lang.String getMemberId()
      Get the memberId This method is deprecated.
      java.lang.String getMiddleName()
      Gets the middle name of the individual.
      java.lang.String getMiddleNameURL()
      Gets the name of MiddleName URL parameter.
      java.lang.String getMobilePhone1()
      Gets the mobile phone 1 of the individual.
      java.lang.String getMobilePhone1Country()
      Gets the mobile phone 1 country of the individual.
      java.lang.String getMobilePhone1CountryURL()
      Gets the name of MobilePhone1Country URL parameter.
      java.lang.String getMobilePhone1URL()
      Gets the name of MobilePhone1 URL parameter.
      java.lang.String getNickName()
      Gets the nick name of the registration address.
      java.lang.String getNickNameURL()
      Gets the name of NickName URL parameter.
      java.lang.String getNumberOfChildren()
      Gets number of children.
      java.lang.String getNumberOfChildrenURL()
      Gets the name of NumberOfChildren url parameter.
      java.lang.String getOfficeAddress()
      Gets number of children.
      java.lang.String getOfficeAddressURL()
      Gets the name of OfficeAddress URL parameter.
      java.lang.String getOrganizationId()
      Gets the identifies the Organization to which this business profile is associated with (BUSPROF table).
      java.lang.String getOrganizationIdURL()
      Gets the name of OrganizationId URL parameter.
      java.lang.String[][] getOrganizationList()
      Returns a two dimension String array which contains all organizations information in the ORGENTITY table.
      java.lang.String getOrganizationName()
      Gets the identifies the Organization to which this business profile is associated with (BUSPROF table).
      java.lang.String getOrganizationNameURL()
      Gets the name of OrganizationName URL parameter.
      java.lang.String getOrganizationUnitId()
      Gets the identifies the Organization to which this business profile is associated with (BUSPROF table).
      java.lang.String getOrganizationUnitIdURL()
      Gets the name of OrganizationUnitId URL parameter.
      java.lang.String[][] getOrganizationUnitList()
      Return a two dimension String array which contains all organizational units information in the ORGENTITY table First column: Organizational Unit Ids (ORGENTITY Table) Second column: Organizational Unit Names (ORGENTITY Table)
      java.lang.String getOrganizationUnitName()
      Gets the identifies the Organization to which this business profile is associated with (BUSPROF table).
      java.lang.String getOrganizationUnitNameURL()
      Gets the name of OrganizationUnitName URL parameter.
      java.util.Vector getOrgEntityListUserAdmin()
      Gets the top level organizations found in the getOrgEntityUserAdmin method, along with their descendant organizations.
      java.util.Vector getOrgEntityListUserAdminWithSearchCriteria()
      Get all organizations that this user is an administrator for.
      java.util.Vector getOrgEntityUserAdmin()
      Get all the top-level organization IDs where this user has the authority to perform "OrganizationManage":
      java.lang.String getPackageSuppression()
      Gets the package suppression attribute for this user.
      java.lang.String getPackageSuppressionURL()
      Gets the name of PackageSuppression URL parameter.
      java.lang.String getParentMember()
      Get the Distinguished Name of the parent orgentity.
      java.lang.String getParentMemberId()
      Gets the memberId of the parent orgentity.
      java.lang.String getParentMemberIdURL()
      Gets the name of ParentMemberId URL parameter.
      java.lang.String getParentMemberURL()
      Gets the name of ParentMember URL parameter.
      java.lang.String getPersonTitle()
      Gets the title of the person to which this address applies.
      java.lang.String getPersonTitleURL()
      Gets the name of PersonTitle URL parameter.
      java.lang.String getPhone1()
      Gets the number of phone 1.
      java.lang.String getPhone1Type()
      Gets the type of the phone 1.
      java.lang.String getPhone1TypeURL()
      Gets the name of Phone1Type URL parameter.
      java.lang.String getPhone1URL()
      Gets the name of Phone1 URL parameter.
      java.lang.String getPhone2()
      Gets the number of phone 2.
      java.lang.String getPhone2Type()
      Gets the type of the phone 2.
      java.lang.String getPhone2TypeURL()
      Gets the name of Phone2Type URL parameter.
      java.lang.String getPhone2URL()
      Gets the name of Phone2 URL parameter.
      java.lang.String getPhoto()
      Gets the URL or path to the photo of the user.
      java.lang.String getPhotoURL()
      Gets the name of Photo URL parameter.
      java.lang.String getPreferredCommunication()
      Gets the preferred method of communication.
      java.lang.String getPreferredCommunicationURL()
      Gets the name of PreferredCommunication URL parameter.
      java.lang.String getPreferredCurrency()
      Sets the preferred currency in 3-character alphabetic code as per ISO 4217.
      java.lang.String getPreferredCurrencyURL()
      Gets the name of PreferredCurrency URL parameter.
      java.lang.String getPreferredDelivery()
      Gets the preferred delivery method (USERPROF table).
      java.lang.String getPreferredDeliveryURL()
      Gets the name of PreferredDelivery URL parameter.
      java.lang.String getPreferredLanguage()
      Gets the preferred language.
      java.lang.String getPreferredLanguageId()
      Gets the preferred language.
      java.lang.String getPreferredLanguageIdURL()
      Gets the name of PreferredLanguage URL parameter.
      java.lang.String getPreferredLanguageURL()
      Gets the name of PreferredLanguage URL parameter.
      java.lang.String getPreferredMeasure()
      Gets the preferred measurement system.
      java.lang.String getPreferredMeasureURL()
      Gets the name of PreferredMeasure URL parameter.
      java.lang.String getPreviousLastSession()
      Get the date and time when the user previous last visited the WCS site.
      java.lang.String getPreviousLastSessionURL()
      Gets the name of PreviousLastSession URL parameter.
      java.lang.String getPrimary()
      Gets an integer indicating whether the address is a primary address.
      java.lang.String getPrimaryURL()
      Gets the name of Primary URL parameter.
      java.lang.String getProfileType()
      Gets the type of profile this user has.
      java.lang.String getProfileTypeURL()
      Gets the name of Profile Type URL parameter.
      java.lang.String getPublishPhone1()
      Gets an integer indicating whether or not to publish the number of phone 1.
      java.lang.String getPublishPhone1URL()
      Gets the name of the Publish Phone 1 URL parameter.
      java.lang.String getPublishPhone2()
      Gets an integer indicating whether or not to publish the number of phone 2.
      java.lang.String getPublishPhone2URL()
      Gets the name of Publish Phone 2 URL parameter.
      java.lang.String getReceiveSMSNotification()
      Gets the receive SMS notification method (USERPROF table).
      java.lang.String getReceiveSMSNotificationURL()
      Gets the name of ReceiveSMSNotification URL parameter.
      java.lang.String getRegisterType()
      Gets the registration type of this user.
      java.lang.String getRegisterTypeURL()
      Gets the name of Register Type URL parameter.
      java.lang.String getRegistration()
      Gets the data and time when registration happened.
      java.lang.String getRegistrationCancel()
      Gets the data and time when registration was canceled.
      java.lang.String getRegistrationCancelTime()
      Gets the data and time when registration was canceled.
      java.lang.String getRegistrationCancelTimeURL()
      Gets the name of Registration Cancel Time URL parameter.
      java.lang.String getRegistrationCancelURL()
      Gets the name of Registration Cancel URL parameter.
      java.lang.String getRegistrationTime()
      Gets the data and time when registration happened.
      java.lang.String getRegistrationTimeURL()
      Gets the name of RegisterType URL parameter.
      java.lang.String getRegistrationUpdate()
      Gets the data and time when the registration information was last updated.
      java.lang.String getRegistrationUpdateTime()
      Gets the data and time when the registration information was last updated.
      java.lang.String getRegistrationUpdateTimeURL()
      Gets the name of RegistrationUpdateTime URL parameter.
      java.lang.String getRegistrationUpdateURL()
      Gets the name of RegistrationUpdate URL parameter.
      java.lang.String getRegistrationURL()
      Gets the name of Registration URL parameter.
      TypedProperty getRequestProperties()
      Get the request properties.
      java.util.List getRetrieveProperties()
      Deprecated. 
      in Version 6.0. This method is not needed since all the properties will be retrieved.
      java.lang.Integer[] getRoles()
      Get all roles played by this user.
      java.lang.Integer[] getRoles(java.lang.String astrOrgEntityId)
      Get all roles played by this user in the specified organization or organizational unit.
      java.lang.Integer[] getRolesForOrgEntityAndAncestors(java.lang.String astrOrgEntityId)
      Get all roles assigned to this user for the specified orgEntity and all of its ancestor orgentities.
      java.lang.Integer[] getRolesInActiveOrganization()
      Get all roles played by this user in the active organization.
      java.lang.Integer[] getRolesInActiveOrganizationAndAncestors()
      Get all roles played by this user in the active organization and its ancestor organizations.
      RoleDataBean[] getRolesWithDetails()
      Get all roles with detail information played by this user.
      int getSearchCriteriaType() 
      java.lang.String getSearchKeyword() 
      int getSearchMaxThreshold() 
      java.lang.String getSecretary()
      Gets business user's secretary's name
      java.lang.String getSecretaryURL()
      Gets the name of Secretary URL parameter.
      AddressDataBean getSelfAddressDataBean()
      Get the user's self address.
      java.lang.String[][] getSortedCurrencyList()
      Return a two dimension String array which contains all currency information in the SETCUR table sorted in alphabetically order of the currency description.
      java.lang.String[][] getSortedLanguageList()
      Return a two dimension String array which contains all language information in the LANGUAGE and LANGUAGEDS tables sorted in alphabetically order of the language description.
      java.lang.String getState()
      Gets the name of the state, province, or equivalent where the individual resides.
      java.lang.String getStateURL()
      Gets the name of State URL parameter.
      java.lang.String getStoreDirectory()
      Gets the name of the store directory, which is used in getUserRegistrationProperties for the path to the property file.
      java.lang.String getStoreIdURL()
      Gets the name of StoreId URL parameter.
      java.util.Vector getTopLevelOrganizationsDirectlyAdministered()
      Get all the top-level organization IDs where this user has the authority to perform "OrganizationManage":
      java.lang.String getType()
      Get the type of the member.
      java.lang.String getUrlURL()
      Gets the name of URL parameter: Url.
      java.lang.String getUserField1()
      Gets user field 1 reserved for customization (USERS table).
      java.lang.String getUserField1URL()
      Gets the name of UserField1 URL parameter.
      java.lang.String getUserField2()
      Gets user field 2 reserved for customization (USERS table).
      java.lang.String getUserField2URL()
      Gets the name of UserField2 URL parameter.
      java.lang.String getUserField3()
      Gets user field 3 reserved for customization (USERS table).
      java.lang.String getUserField3URL()
      Gets the name of UserField3 URL parameter.
      java.lang.String getUserId()
      Gets the userId
      UserProfileAccessBean getUserProfile()
      Gets the UserProfileAccessBean of this member.
      UserProfileDataBean getUserProfileDataBean()
      Getter for the UserProfileDataBean for this user.
      java.lang.String getUserProfileField1()
      Gets user profile field 1 reserved for customization (USERPROF table).
      java.lang.String getUserProfileField1URL()
      Gets the name of UserProfileField1 URL parameter.
      java.lang.String getUserProfileField2()
      Gets user profile field 2 reserved for customization (USERPROF table).
      java.lang.String getUserProfileField2URL()
      Gets the name of UserProfileField2 URL parameter.
      UserRegistryDataBean getUserRegistryDataBean()
      Getter for the UserRegistryDataBean for this user.
      java.lang.String getZipCode()
      Gets the zip code or equivalent postal code of the individual's address.
      java.lang.String getZipCodeURL()
      Gets the name of ZipCode URL parameter.
      boolean hasNumOfSearchResultsExceededMax()
      To check the recent search results exceeding specified threshold.
      boolean isMemberInRole(java.lang.String astrRoleName)
      Gets a boolean value which indicates whether this user plays the specified role.
      boolean isMemberInRole(java.lang.String astrRoleName, java.lang.Long anOrgEntityId)
      Gets a boolean value which indicates whether this user plays the specified role in the specified organization or organizational unit.
      boolean isMemberInRole(java.lang.String astrRoleName, java.lang.String astrOrgEntityId)
      Gets a boolean value which indicates whether this user plays the specified role in the specified organization or organizational unit.
      void populate()
      Activate the bean.
      void setCommandContext(CommandContext aCommandContext)
      Set the command context.
      void setDataBeanKeyMemberId(java.lang.String aUserId)
      Set the user Id.
      void setPopulateFromTransactionCache(boolean abPopulateFromTransactionCache)
      Set the populateFromTransactionCache property.
      void setProfileType(java.lang.String astrProfileType)
      Deprecated. 
      since version 6.0. This method is not needed since getProfileType() retrieves its value from the user object, not the instance variable.
      void setRequestProperties(TypedProperty aRequestProperty)
      Set the request properties.
      void setRetrieveProperties(java.util.List propertyNames)
      Deprecated. 
      in Version 6.0. This method is not needed since all the properties will be retrieved.
      void setSearchCriteria(int searchType, java.lang.String searchString, int maxNumOfResult)
      To specify the search criteria option before invoking the method getOrgEntityListUserAdminWithSearchCriteria().
      void setSearchCriteriaType(int searchType)
      To specify the search criteria option before invoking the method getOrgEntityListUserAdminWithSearchCriteria().
      void setSearchKeyword(java.lang.String searchString)
      To specify the search keyword string before invoking the method getOrgEntityListUserAdminWithSearchCriteria().
      void setSearchMaxThreshold(int maxNumOfResult)
      To specify the threshold of max.
      void setStoreDirectory(java.lang.String astrStoreDirectory)
      Sets the name of store directory, which is used as the path to find the property file in getUserRegistrationProperties method.
      void setUserId(java.lang.Long aUserId)
      Sets the key(user id) of this data bean.
      void setUserId(java.lang.String aUserId)
      Sets the key (user Id) of this data bean.
      • Methods inherited from class java.lang.Object

        equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Field Detail

      • COPYRIGHT

        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 fully qualified name of this class.
        See Also:
        Constant Field Values
      • SEARCHTYPE_SEARCH_ALL

        public static final int SEARCHTYPE_SEARCH_ALL
        Default search with all search type constant
        See Also:
        Constant Field Values
      • SEARCHTYPE_MATCH_CASE_BEGIN

        public static final int SEARCHTYPE_MATCH_CASE_BEGIN
        Match case beginning with keyword search type constant
        See Also:
        Constant Field Values
      • SEARCHTYPE_MATCH_CASE_CONTAIN

        public static final int SEARCHTYPE_MATCH_CASE_CONTAIN
        Match case containing with keyword search type constant
        See Also:
        Constant Field Values
      • SEARCHTYPE_IGNORE_CASE_BEGIN

        public static final int SEARCHTYPE_IGNORE_CASE_BEGIN
        Ignore case beginning with keyword search type constant
        See Also:
        Constant Field Values
      • SEARCHTYPE_IGNORE_CASE_CONTAIN

        public static final int SEARCHTYPE_IGNORE_CASE_CONTAIN
        Ignore case containing with keyword search type constant
        See Also:
        Constant Field Values
      • SEARCHTYPE_EXACT_MATCH

        public static final int SEARCHTYPE_EXACT_MATCH
        Exact Match with keyword search type constant
        See Also:
        Constant Field Values
    • Constructor Detail

      • UserRegistrationDataBean

        public UserRegistrationDataBean()
        RegisterDataBean constructor
    • Method Detail

      • setPopulateFromTransactionCache

        public void setPopulateFromTransactionCache(boolean abPopulateFromTransactionCache)
        Set the populateFromTransactionCache property.
        Parameters:
        abPopulateFromTransactionCache - specify true to use a transaction cached UserSyncBean, to avoid re-creating one.
      • findUser

        public boolean findUser()
        Returns a boolean value indicating whether the user is found according to the specified userId. True - The specified user is found False - Can not find the specified user
        Specified by:
        findUser in interface com.ibm.commerce.user.beans.UserRegistrationSmartDataBean
        Returns:
        A boolean value indicating whether the specified user is found
      • getAddress

        public AddressAccessBean getAddress()
        Return the register address (User's own address).
        Specified by:
        getAddress in interface com.ibm.commerce.user.beans.UserRegistrationSmartDataBean
        Returns:
        AddressAccessBean The register address
      • getAddress1

        public java.lang.String getAddress1()
        Gets the first line of the address.
        Specified by:
        getAddress1 in interface com.ibm.commerce.user.beans.UserRegistrationSmartDataBean
        Returns:
        The first line of the address
      • getAddress1URL

        public java.lang.String getAddress1URL()
        Gets the name of Address1 url parameter.
        Specified by:
        getAddress1URL in interface com.ibm.commerce.user.beans.UserRegistrationSmartDataBean
        Returns:
        The name of Address1 url parameter
      • getAddress2

        public java.lang.String getAddress2()
        Gets the second line of the address.
        Specified by:
        getAddress2 in interface com.ibm.commerce.user.beans.UserRegistrationSmartDataBean
        Returns:
        The second line of the address
      • getAddress2URL

        public java.lang.String getAddress2URL()
        Gets the name of Address2 url parameter.
        Specified by:
        getAddress2URL in interface com.ibm.commerce.user.beans.UserRegistrationSmartDataBean
        Returns:
        The name of Address2 url parameter
      • getAddress3

        public java.lang.String getAddress3()
        Gets the third line of the address.
        Specified by:
        getAddress3 in interface com.ibm.commerce.user.beans.UserRegistrationSmartDataBean
        Returns:
        The third line of the address
      • getAddress3URL

        public java.lang.String getAddress3URL()
        Gets the name of Address3 url parameter.
        Specified by:
        getAddress3URL in interface com.ibm.commerce.user.beans.UserRegistrationSmartDataBean
        Returns:
        The name of Address3 url parameter
      • getAddressBook

        public AddressBookAccessBean getAddressBook()
        Gets the AddressBookAccessBean of this member.
        Specified by:
        getAddressBook in interface com.ibm.commerce.user.beans.UserRegistrationSmartDataBean
        Returns:
        The AddressBookAccessBean of this member
      • getAddressField1

        public java.lang.String getAddressField1()
        Gets the customizable address field 1.
        Specified by:
        getAddressField1 in interface com.ibm.commerce.user.beans.UserRegistrationSmartDataBean
        Returns:
        astrField1 The customizable address field 1
      • getAddressField1URL

        public java.lang.String getAddressField1URL()
        Gets the name of Address3 url parameter.
        Specified by:
        getAddressField1URL in interface com.ibm.commerce.user.beans.UserRegistrationSmartDataBean
        Returns:
        The name of Address3 url parameter
      • getAddressField2

        public java.lang.String getAddressField2()
        Gets the customizable address field 2.
        Specified by:
        getAddressField2 in interface com.ibm.commerce.user.beans.UserRegistrationSmartDataBean
        Returns:
        astrField2 The customizable address field 2
      • getAddressField2URL

        public java.lang.String getAddressField2URL()
        Gets the name of Address3 url parameter.
        Specified by:
        getAddressField2URL in interface com.ibm.commerce.user.beans.UserRegistrationSmartDataBean
        Returns:
        The name of Address3 url parameter
      • getAddressField3

        public java.lang.String getAddressField3()
        Gets the customizable address field 3.
        Specified by:
        getAddressField3 in interface com.ibm.commerce.user.beans.UserRegistrationSmartDataBean
        Returns:
        astrField3 The customizable address field 3
      • getAddressField3URL

        public java.lang.String getAddressField3URL()
        Gets the name of Address3 url parameter.
        Specified by:
        getAddressField3URL in interface com.ibm.commerce.user.beans.UserRegistrationSmartDataBean
        Returns:
        The name of Address3 url parameter
      • getAddressId

        public java.lang.String getAddressId()
        Gets the address id for this registration address.
        Specified by:
        getAddressId in interface com.ibm.commerce.user.beans.UserRegistrationSmartDataBean
        Returns:
        The address id of the registration address
      • getAddressIdURL

        public java.lang.String getAddressIdURL()
        Gets the name of AddressId url parameter.
        Specified by:
        getAddressIdURL in interface com.ibm.commerce.user.beans.UserRegistrationSmartDataBean
        Returns:
        The name of AddressId url parameter
      • getAddressType

        public java.lang.String getAddressType()
        Gets the address type for this registration address.
        Specified by:
        getAddressType in interface com.ibm.commerce.user.beans.UserRegistrationSmartDataBean
        Returns:
        The address type of the registration address
      • getAddressTypeURL

        public java.lang.String getAddressTypeURL()
        Gets the name of AddressType url parameter.
        Specified by:
        getAddressTypeURL in interface com.ibm.commerce.user.beans.UserRegistrationSmartDataBean
        Returns:
        The name of AddressType url parameter
      • getAge

        public java.lang.String getAge()
        Gets an integer which indicates the age of the user.
        Specified by:
        getAge in interface com.ibm.commerce.user.beans.UserRegistrationSmartDataBean
        Returns:
        The age of the user 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
      • getAgeURL

        public java.lang.String getAgeURL()
        Gets the name of Age url parameter.
        Specified by:
        getAgeURL in interface com.ibm.commerce.user.beans.UserRegistrationSmartDataBean
        Returns:
        The name of Age url parameter
      • getAlternateId

        public java.lang.String getAlternateId()
        Gets the special ID assigned by this business user's O or OU to this business user . (eg. the SBREQID in SHBTB table in BPF)
        Specified by:
        getAlternateId in interface com.ibm.commerce.user.beans.UserRegistrationSmartDataBean
        Returns:
        The special ID assigned by this business user's O or OU to this business user
      • getAlternateIdURL

        public java.lang.String getAlternateIdURL()
        Gets the name of AlternateId url parameter.
        Specified by:
        getAlternateIdURL in interface com.ibm.commerce.user.beans.UserRegistrationSmartDataBean
        Returns:
        The name of AlternateId url parameter
      • getAncestors

        public java.lang.Long[] getAncestors()
        Get a list of all ancestor orgentities of this user.
        Specified by:
        getAncestors in interface com.ibm.commerce.user.beans.UserRegistrationSmartDataBean
        Returns:
        A list of all ancestor orgentities of this user; if no ancestors then returns an empty array.
      • getAttribute

        public java.lang.String getAttribute(java.lang.String astrAttributeName)
        Gets attribute value according to the specified attribute name. All user attributes can be get by using this method.
        For example:
         getAttribute("lastName")
         - returns the last name of this user. This method is the same as getLastName().
         
        Specified by:
        getAttribute in interface com.ibm.commerce.user.beans.UserRegistrationSmartDataBean
        Parameters:
        astrAttributeName - The name of the attribute
        Returns:
        The value of the attribute
      • getAttribute

        public java.util.Vector getAttribute(java.lang.String astrAttributeName,
                                             java.lang.String astrStoreEntityId)
        Gets the Vector which contains values of the multiple-valued or context-based attribute according to the specified attribute name and optional StoreEntityId. If StoreEntityId is null, the method returns store-independent multiple values. For example:
         getAttribute("ReferredBy", null)
         - returns the ReferredBy attribute, which may have multiple values.
         
        Specified by:
        getAttribute in interface com.ibm.commerce.user.beans.UserRegistrationSmartDataBean
        Parameters:
        astrAttributeName - The name of the multiple-valued or context-based attribute
        astrStoreEntityId - The StoreEntityId
        Returns:
        The Vector which contains values of the multiple-valued or context-based attribute
      • getAttributes

        public TypedProperty getAttributes()
        Gets the TypedProperty which contains all attributes for this user.
        Specified by:
        getAttributes in interface com.ibm.commerce.user.beans.UserRegistrationSmartDataBean
        Returns:
        The TypedProperty which contains all attributes for this user.
      • getBestCallingTime

        public java.lang.String getBestCallingTime()
        Gets the indicator for the best time to call the individual.
        Specified by:
        getBestCallingTime in interface com.ibm.commerce.user.beans.UserRegistrationSmartDataBean
        Returns:
        The best time to call For example:
        • D - Daytime
        • E - Evening
      • getBestCallingTimeURL

        public java.lang.String getBestCallingTimeURL()
        Gets the name of BestCallingTime url parameter.
        Specified by:
        getBestCallingTimeURL in interface com.ibm.commerce.user.beans.UserRegistrationSmartDataBean
        Returns:
        The name of BestCallingTime url parameter
      • getBillingCode

        public java.lang.String getBillingCode()
        Gets the indicator for the best time to call the individual.
        Specified by:
        getBillingCode in interface com.ibm.commerce.user.beans.UserRegistrationSmartDataBean
        Returns:
        The best time to call For example:
        • D - Daytime
        • E - Evening
      • getBillingCodeType

        public java.lang.String getBillingCodeType()
        Gets the indicator for the best time to call the individual.
        Specified by:
        getBillingCodeType in interface com.ibm.commerce.user.beans.UserRegistrationSmartDataBean
        Returns:
        The best time to call For example:
        • D - Daytime
        • E - Evening
      • getBillingCodeTypeURL

        public java.lang.String getBillingCodeTypeURL()
        Gets the name of BillingCodeType url parameter.
        Specified by:
        getBillingCodeTypeURL in interface com.ibm.commerce.user.beans.UserRegistrationSmartDataBean
        Returns:
        The name of BillingCodeType url parameter
      • getBillingCodeURL

        public java.lang.String getBillingCodeURL()
        Gets the name of BillingCode url parameter.
        Specified by:
        getBillingCodeURL in interface com.ibm.commerce.user.beans.UserRegistrationSmartDataBean
        Returns:
        The name of BillingCode url parameter
      • getBusinessTitle

        public java.lang.String getBusinessTitle()
        Gets the business title of the person to which this address applies, eg. Manager, Vice President.
        Specified by:
        getBusinessTitle in interface com.ibm.commerce.user.beans.UserRegistrationSmartDataBean
        Returns:
        The business title For example:
        • P - President
        • M - Manager
      • getBusinessTitleURL

        public java.lang.String getBusinessTitleURL()
        Gets the name of BusinessTitle url parameter.
        Specified by:
        getBusinessTitleURL in interface com.ibm.commerce.user.beans.UserRegistrationSmartDataBean
        Returns:
        The name of BusinessTitle url parameter
      • getChallengeAnswer

        public java.lang.String getChallengeAnswer()
        Gets the answer to the challenge question.
        Specified by:
        getChallengeAnswer in interface com.ibm.commerce.user.beans.UserRegistrationSmartDataBean
        Returns:
        The answer to the challenge question
      • getChallengeAnswerURL

        public java.lang.String getChallengeAnswerURL()
        Gets the name of ChallengeAnswer url parameter.
        Specified by:
        getChallengeAnswerURL in interface com.ibm.commerce.user.beans.UserRegistrationSmartDataBean
        Returns:
        The name of ChallengeAnswer url parameter
      • getChallengeQuestion

        public java.lang.String getChallengeQuestion()
        Gets the challenge question for the user.
        Specified by:
        getChallengeQuestion in interface com.ibm.commerce.user.beans.UserRegistrationSmartDataBean
        Returns:
        The challenge question
      • getChallengeQuestionURL

        public java.lang.String getChallengeQuestionURL()
        Gets the name of ChallengeQuestion url parameter.
        Specified by:
        getChallengeQuestionURL in interface com.ibm.commerce.user.beans.UserRegistrationSmartDataBean
        Returns:
        The name of ChallengeQuestion url parameter
      • getChildrenURL

        public java.lang.String getChildrenURL()
        Gets the name of Children url parameter.
        Specified by:
        getChildrenURL in interface com.ibm.commerce.user.beans.UserRegistrationSmartDataBean
        Returns:
        The name of Children url parameter
      • getCity

        public java.lang.String getCity()
        Gets the city name.
        Specified by:
        getCity in interface com.ibm.commerce.user.beans.UserRegistrationSmartDataBean
        Returns:
        The city name
      • getCityURL

        public java.lang.String getCityURL()
        Gets the name of City url parameter.
        Specified by:
        getCityURL in interface com.ibm.commerce.user.beans.UserRegistrationSmartDataBean
        Returns:
        The name of City url parameter
      • getCommandContext

        public CommandContext getCommandContext()
        Gets the command context.
        Specified by:
        getCommandContext in interface SmartDataBean
        Specified by:
        getCommandContext in interface com.ibm.commerce.user.beans.UserRegistrationSmartDataBean
        Returns:
        The command context
      • getCompanyName

        public java.lang.String getCompanyName()
        Gets the name of the company for which the user works
        Specified by:
        getCompanyName in interface com.ibm.commerce.user.beans.UserRegistrationSmartDataBean
        Returns:
        The name of the company
      • getCompanyNameURL

        public java.lang.String getCompanyNameURL()
        Gets the name of CompanyName url parameter.
        Specified by:
        getCompanyNameURL in interface com.ibm.commerce.user.beans.UserRegistrationSmartDataBean
        Returns:
        The name of CompanyName url parameter
      • getCountry

        public java.lang.String getCountry()
        Gets the country name.
        Specified by:
        getCountry in interface com.ibm.commerce.user.beans.UserRegistrationSmartDataBean
        Returns:
        The country name
      • getCountryURL

        public java.lang.String getCountryURL()
        Gets the name of Country url parameter.
        Specified by:
        getCountryURL in interface com.ibm.commerce.user.beans.UserRegistrationSmartDataBean
        Returns:
        The name of Country url parameter
      • getCurrencyList

        public java.lang.String[][] getCurrencyList()
        Return a two dimension String array which contains all currency information in the SETCURR table. First column: Currency Code (SETCURR Table) Second column: Currency Name (SETCURR Table) This method is deprecated. getCurrencyList() method in CurrencyListDataBean should be used instead.
        Specified by:
        getCurrencyList in interface com.ibm.commerce.user.beans.UserRegistrationSmartDataBean
        Returns:
        String[][] Two dimension String array which contains currency code and currency name from SETCURR tables
      • getDataBeanKeyMemberId

        public java.lang.String getDataBeanKeyMemberId()
        Gets the user Id.
        Specified by:
        getDataBeanKeyMemberId in interface com.ibm.commerce.user.beans.UserRegistrationSmartDataBean
        Returns:
        The user Id.
      • getDelegate

        public Protectable getDelegate()
                                throws java.lang.Exception
        getDelegate method comment.
        Specified by:
        getDelegate in interface Delegator
        Returns:
        The delegate, in this case, a UserDataBean
        Throws:
        java.lang.Exception
      • getDemoField1URL

        public java.lang.String getDemoField1URL()
        Gets the name of DemoField1 url parameter.
        Specified by:
        getDemoField1URL in interface com.ibm.commerce.user.beans.UserRegistrationSmartDataBean
        Returns:
        The name of DemoField1 url parameter
      • getDemoField2URL

        public java.lang.String getDemoField2URL()
        Gets the name of DemoField2 url parameter.
        Specified by:
        getDemoField2URL in interface com.ibm.commerce.user.beans.UserRegistrationSmartDataBean
        Returns:
        The name of DemoField2 url parameter
      • getDemoField3URL

        public java.lang.String getDemoField3URL()
        Gets the name of DemoField3 url parameter.
        Specified by:
        getDemoField3URL in interface com.ibm.commerce.user.beans.UserRegistrationSmartDataBean
        Returns:
        The name of DemoField3 url parameter
      • getDemoField4URL

        public java.lang.String getDemoField4URL()
        Gets the name of DemoField4 url parameter.
        Specified by:
        getDemoField4URL in interface com.ibm.commerce.user.beans.UserRegistrationSmartDataBean
        Returns:
        The name of DemoField4 url parameter
      • getDemoField5URL

        public java.lang.String getDemoField5URL()
        Gets the name of DemoField5 url parameter.
        Specified by:
        getDemoField5URL in interface com.ibm.commerce.user.beans.UserRegistrationSmartDataBean
        Returns:
        The name of DemoField5 url parameter
      • getDemoField6URL

        public java.lang.String getDemoField6URL()
        Gets the name of DemoField6 url parameter.
        Specified by:
        getDemoField6URL in interface com.ibm.commerce.user.beans.UserRegistrationSmartDataBean
        Returns:
        The name of DemoField6 url parameter
      • getDemoField7URL

        public java.lang.String getDemoField7URL()
        Gets the name of DemoField7 url parameter.
        Specified by:
        getDemoField7URL in interface com.ibm.commerce.user.beans.UserRegistrationSmartDataBean
        Returns:
        The name of DemoField7 url parameter
      • getDemographics

        public DemographicsAccessBean getDemographics()
        Gets the DemographicsAccessBean of this member.
        Specified by:
        getDemographics in interface com.ibm.commerce.user.beans.UserRegistrationSmartDataBean
        Returns:
        The DemographicsAccessBean of this member
      • getDemographicsField1

        public java.lang.String getDemographicsField1()
        Deprecated. in version 6.0. Use getDemographicField1() instead.
        Gets the demographic field1 reserved for customization.
        Specified by:
        getDemographicsField1 in interface com.ibm.commerce.user.beans.UserRegistrationSmartDataBean
        Returns:
        The demographic field1
      • getDemographicsField2

        public java.lang.String getDemographicsField2()
        Deprecated. in version 6.0. Use getDemographicField2() instead.
        Gets the demographic field2 reserved for customization.
        Specified by:
        getDemographicsField2 in interface com.ibm.commerce.user.beans.UserRegistrationSmartDataBean
        Returns:
        The demographic field2
      • getDemographicsField3

        public java.lang.String getDemographicsField3()
        Deprecated. in version 6.0. Use getDemographicField3() instead.
        Gets the demographic field3 reserved for customization.
        Specified by:
        getDemographicsField3 in interface com.ibm.commerce.user.beans.UserRegistrationSmartDataBean
        Returns:
        The demographic field3
      • getDemographicsField4

        public java.lang.String getDemographicsField4()
        Deprecated. in version 6.0. Use getDemographicField4() instead.
        Gets the demographic field4 reserved for customization.
        Specified by:
        getDemographicsField4 in interface com.ibm.commerce.user.beans.UserRegistrationSmartDataBean
        Returns:
        The demographic field4
      • getDemographicsField5

        public java.lang.String getDemographicsField5()
        Deprecated. in version 6.0. Use getDemographicField5() instead.
        Gets the demographic field5 reserved for customization.
        Specified by:
        getDemographicsField5 in interface com.ibm.commerce.user.beans.UserRegistrationSmartDataBean
        Returns:
        The demographic field5
      • getDemographicsField6

        public java.lang.String getDemographicsField6()
        Deprecated. in version 6.0. Use getDemographicField6() instead.
        Gets the demographic field6 reserved for customization.
        Specified by:
        getDemographicsField6 in interface com.ibm.commerce.user.beans.UserRegistrationSmartDataBean
        Returns:
        The demographic field6
      • getDemographicsField7

        public java.lang.String getDemographicsField7()
        Deprecated. in version 6.0. Use getDemographicField7() instead.
        Gets the demographic field7 reserved for customization.
        Specified by:
        getDemographicsField7 in interface com.ibm.commerce.user.beans.UserRegistrationSmartDataBean
        Returns:
        The demographic field7
      • getDemographicField1

        public java.lang.String getDemographicField1()
        Gets the demographic field1 reserved for customization.
        Returns:
        The demographic field1
      • getDemographicField2

        public java.lang.String getDemographicField2()
        Gets the demographic field2 reserved for customization.
        Returns:
        The demographic field2
      • getDemographicField3

        public java.lang.String getDemographicField3()
        Gets the demographic field3 reserved for customization.
        Returns:
        The demographic field3
      • getDemographicField4

        public java.lang.String getDemographicField4()
        Gets the demographic field4 reserved for customization.
        Returns:
        The demographic field4
      • getDemographicField5

        public java.lang.String getDemographicField5()
        Gets the demographic field5 reserved for customization.
        Returns:
        The demographic field5
      • getDemographicField6

        public java.lang.String getDemographicField6()
        Gets the demographic field6 reserved for customization.
        Returns:
        The demographic field6
      • getDemographicField7

        public java.lang.String getDemographicField7()
        Gets the demographic field7 reserved for customization.
        Returns:
        The demographic field7
      • getDepartmentNumber

        public java.lang.String getDepartmentNumber()
        Gets the department number where the member works (BUSPROF table).
        Specified by:
        getDepartmentNumber in interface com.ibm.commerce.user.beans.UserRegistrationSmartDataBean
        Returns:
        The department number where the member works
      • getDepartmentNumberURL

        public java.lang.String getDepartmentNumberURL()
        Gets the name of DepartmentNumber url parameter.
        Specified by:
        getDepartmentNumberURL in interface com.ibm.commerce.user.beans.UserRegistrationSmartDataBean
        Returns:
        The name of DepartmentNumber url parameter
      • getDescription

        public java.lang.String getDescription()
        Gets the Description (USERPROF table). LDAP has a description attribute for various person type of objects, and o/OU, and groupOfNames
        Specified by:
        getDescription in interface com.ibm.commerce.user.beans.UserRegistrationSmartDataBean
        Returns:
        The Description
      • getDescriptionURL

        public java.lang.String getDescriptionURL()
        Gets the name of Description url parameter.
        Specified by:
        getDescriptionURL in interface com.ibm.commerce.user.beans.UserRegistrationSmartDataBean
        Returns:
        The name of Description url parameter
      • getDisplayName

        public java.lang.String getDisplayName()
        Gets 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.
        Specified by:
        getDisplayName in interface com.ibm.commerce.user.beans.UserRegistrationSmartDataBean
        Returns:
        The display name of the entry
      • getDisplayNameURL

        public java.lang.String getDisplayNameURL()
        Gets the name of DisplayName url parameter.
        Specified by:
        getDisplayNameURL in interface com.ibm.commerce.user.beans.UserRegistrationSmartDataBean
        Returns:
        The name of DisplayName url parameter
      • getDistinguishedName

        public java.lang.String getDistinguishedName()
        Sets the distinguished name of the entry (USERS table). Used for coordination with LDAP.
        Specified by:
        getDistinguishedName in interface com.ibm.commerce.user.beans.UserRegistrationSmartDataBean
        Returns:
        The distinguished name of the entry
      • getDistinguishedNameURL

        public java.lang.String getDistinguishedNameURL()
        Gets the name of DistinguishedName url parameter.
        Specified by:
        getDistinguishedNameURL in interface com.ibm.commerce.user.beans.UserRegistrationSmartDataBean
        Returns:
        The name of DistinguishedName url parameter
      • getEmail1

        public java.lang.String getEmail1()
        Gets the e-mail or URL address 1 of the individual.
        Specified by:
        getEmail1 in interface com.ibm.commerce.user.beans.UserRegistrationSmartDataBean
        Returns:
        The e-mail or URL address 1 of the individual
      • getEmail1URL

        public java.lang.String getEmail1URL()
        Gets the name of Email1 URL parameter.
        Specified by:
        getEmail1URL in interface com.ibm.commerce.user.beans.UserRegistrationSmartDataBean
        Returns:
        The name of Email1 URL parameter
      • getEmail2

        public java.lang.String getEmail2()
        Gets the e-mail or URL address 2 of the individual.
        Specified by:
        getEmail2 in interface com.ibm.commerce.user.beans.UserRegistrationSmartDataBean
        Returns:
        The e-mail or URL address 2 of the individual
      • getEmail2URL

        public java.lang.String getEmail2URL()
        Gets the name of Email2 URL parameter.
        Specified by:
        getEmail2URL in interface com.ibm.commerce.user.beans.UserRegistrationSmartDataBean
        Returns:
        The name of Email2 URL parameter
      • getEmployeeId

        public java.lang.String getEmployeeId()
        Gets the employee identification (BUSPROF table).
        Specified by:
        getEmployeeId in interface com.ibm.commerce.user.beans.UserRegistrationSmartDataBean
        Returns:
        The employee identification
      • getEmployeeIdURL

        public java.lang.String getEmployeeIdURL()
        Gets the name of EmployeeId URL parameter.
        Specified by:
        getEmployeeIdURL in interface com.ibm.commerce.user.beans.UserRegistrationSmartDataBean
        Returns:
        The name of EmployeeId URL parameter
      • getEmployeeType

        public java.lang.String getEmployeeType()
        Gets the employee type. Such as regular, part-time, special part-time.
        Specified by:
        getEmployeeType in interface com.ibm.commerce.user.beans.UserRegistrationSmartDataBean
        Returns:
        The employee type
      • getEmployeeTypeURL

        public java.lang.String getEmployeeTypeURL()
        Gets the name of EmployeeType URL parameter.
        Specified by:
        getEmployeeTypeURL in interface com.ibm.commerce.user.beans.UserRegistrationSmartDataBean
        Returns:
        The name of EmployeeType URL parameter
      • getFax1

        public java.lang.String getFax1()
        Gets the facsimile number 1 of the individual.
        Specified by:
        getFax1 in interface com.ibm.commerce.user.beans.UserRegistrationSmartDataBean
        Returns:
        The facsimile number 1
      • getFax1URL

        public java.lang.String getFax1URL()
        Gets the name of Fax1 URL parameter.
        Specified by:
        getFax1URL in interface com.ibm.commerce.user.beans.UserRegistrationSmartDataBean
        Returns:
        The name of Fax1 URL parameter
      • getFax2

        public java.lang.String getFax2()
        Gets the facsimile number 2 of the individual.
        Specified by:
        getFax2 in interface com.ibm.commerce.user.beans.UserRegistrationSmartDataBean
        Returns:
        The facsimile number 2
      • getFax2URL

        public java.lang.String getFax2URL()
        Gets the name of Fax2 URL parameter.
        Specified by:
        getFax2URL in interface com.ibm.commerce.user.beans.UserRegistrationSmartDataBean
        Returns:
        The name of Fax2 URL parameter
      • getMobilePhone1

        public java.lang.String getMobilePhone1()
        Gets the mobile phone 1 of the individual.
        Specified by:
        getMobilePhone1 in interface com.ibm.commerce.user.beans.UserRegistrationSmartDataBean
        Returns:
        The mobile phone 1
      • getMobilePhone1URL

        public java.lang.String getMobilePhone1URL()
        Gets the name of MobilePhone1 URL parameter.
        Specified by:
        getMobilePhone1URL in interface com.ibm.commerce.user.beans.UserRegistrationSmartDataBean
        Returns:
        The name of MobilePhone1 URL parameter
      • getMobilePhone1Country

        public java.lang.String getMobilePhone1Country()
        Gets the mobile phone 1 country of the individual.
        Specified by:
        getMobilePhone1Country in interface com.ibm.commerce.user.beans.UserRegistrationSmartDataBean
        Returns:
        The mobile phone 1 country
      • getMobilePhone1CountryURL

        public java.lang.String getMobilePhone1CountryURL()
        Gets the name of MobilePhone1Country URL parameter.
        Specified by:
        getMobilePhone1CountryURL in interface com.ibm.commerce.user.beans.UserRegistrationSmartDataBean
        Returns:
        The name of MobilePhone1Country URL parameter
      • getFirstName

        public java.lang.String getFirstName()
        Gets the first name of the individual.
        Specified by:
        getFirstName in interface com.ibm.commerce.user.beans.UserRegistrationSmartDataBean
        Returns:
        The first name
      • getFirstNameURL

        public java.lang.String getFirstNameURL()
        Gets the name of FirstName URL parameter.
        Specified by:
        getFirstNameURL in interface com.ibm.commerce.user.beans.UserRegistrationSmartDataBean
        Returns:
        The name of FirstName URL parameter
      • getGender

        public java.lang.String getGender()
        Gets the gender associated with this user.
        Specified by:
        getGender in interface com.ibm.commerce.user.beans.UserRegistrationSmartDataBean
        Returns:
        The gender associated with this user For example:
        • N - Not provided (default)
        • F - Female
        • M - Male
      • getGenderURL

        public java.lang.String getGenderURL()
        Gets the name of Gender URL parameter.
        Specified by:
        getGenderURL in interface com.ibm.commerce.user.beans.UserRegistrationSmartDataBean
        Returns:
        The name of Gender URL parameter
      • getHobbies

        public java.lang.String getHobbies()
        Gets the main interests and hobbies of this person.
        Specified by:
        getHobbies in interface com.ibm.commerce.user.beans.UserRegistrationSmartDataBean
        Returns:
        The main interests and hobbies of this person
      • getHobbiesURL

        public java.lang.String getHobbiesURL()
        Gets the name of Hobbies URL parameter.
        Specified by:
        getHobbiesURL in interface com.ibm.commerce.user.beans.UserRegistrationSmartDataBean
        Returns:
        The name of Hobbies URL parameter
      • getDateOfBirth

        public java.lang.String getDateOfBirth()
        Gets the date of birth of this person.
        Specified by:
        getDateOfBirth in interface com.ibm.commerce.user.beans.UserRegistrationSmartDataBean
        Returns:
        The date of birth of this person
      • getDateOfBirthURL

        public java.lang.String getDateOfBirthURL()
        Gets the name of DateOfBirth URL parameter.
        Specified by:
        getDateOfBirthURL in interface com.ibm.commerce.user.beans.UserRegistrationSmartDataBean
        Returns:
        The name of DateOfBirth URL parameter
      • getHousehold

        public java.lang.String getHousehold()
        Gets the number of people within the household of this user.
        Specified by:
        getHousehold in interface com.ibm.commerce.user.beans.UserRegistrationSmartDataBean
        Returns:
        The number of people within the household
      • getHouseholdURL

        public java.lang.String getHouseholdURL()
        Gets the name of Household URL parameter.
        Specified by:
        getHouseholdURL in interface com.ibm.commerce.user.beans.UserRegistrationSmartDataBean
        Returns:
        The name of Household URL parameter
      • getIncome

        public java.lang.String getIncome()
        Gets the annual income category for this person.
        Specified by:
        getIncome in interface com.ibm.commerce.user.beans.UserRegistrationSmartDataBean
        Returns:
        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
      • getIncomeURL

        public java.lang.String getIncomeURL()
        Gets the name of Income URL parameter.
        Specified by:
        getIncomeURL in interface com.ibm.commerce.user.beans.UserRegistrationSmartDataBean
        Returns:
        The name of Income URL parameter
      • getLanguageList

        public java.lang.String[][] getLanguageList()
        Return a two dimension String array which contains all language information in the LANGUAGE and LANGUAGEDS tables. First column: Language Ids (LANGUAGE Table) Second column: Language Descriptions (LANGUAGEDS Table) This method is deprecated. getLanguageList() method in LanguageListDataBean should be used instead.
        Specified by:
        getLanguageList in interface com.ibm.commerce.user.beans.UserRegistrationSmartDataBean
        Returns:
        String[][] A two dimension String array which contains languages ids and languages descriptions from the LANGUAGE and LANGUAGEDS tables
      • getLastName

        public java.lang.String getLastName()
        Gets the last name of the individual.
        Specified by:
        getLastName in interface com.ibm.commerce.user.beans.UserRegistrationSmartDataBean
        Returns:
        The last name
      • getLastNameURL

        public java.lang.String getLastNameURL()
        Gets the name of LastName URL parameter.
        Specified by:
        getLastNameURL in interface com.ibm.commerce.user.beans.UserRegistrationSmartDataBean
        Returns:
        The name of LastName URL parameter
      • getLastOrder

        public java.lang.String getLastOrder()
        Get the data and time when last order happened. This method is deprecated. getLastOrderTime() should be used instead.
        Returns:
        The data and time when last order happened
      • getLastOrderTime

        public java.lang.String getLastOrderTime()
        Get the data and time when last order happened.
        Specified by:
        getLastOrderTime in interface com.ibm.commerce.user.beans.UserRegistrationSmartDataBean
        Returns:
        The data and time when last order happened
      • getLastOrderTimeURL

        public java.lang.String getLastOrderTimeURL()
        Gets the name of LastName URL parameter.
        Specified by:
        getLastOrderTimeURL in interface com.ibm.commerce.user.beans.UserRegistrationSmartDataBean
        Returns:
        The name of LastName URL parameter
      • getLastSession

        public java.lang.String getLastSession()
        Get the data and time of user session.
        Specified by:
        getLastSession in interface com.ibm.commerce.user.beans.UserRegistrationSmartDataBean
        Returns:
        The data and time of user session
      • getLastSessionURL

        public java.lang.String getLastSessionURL()
        Gets the name of LastSession URL parameter.
        Specified by:
        getLastSessionURL in interface com.ibm.commerce.user.beans.UserRegistrationSmartDataBean
        Returns:
        The name of LastSession URL parameter
      • getLogonId

        public java.lang.String getLogonId()
        Gets the user's unique login Id. The Id can only contain alphanumeric characters or the symbols '@' and '.'.
        Specified by:
        getLogonId in interface com.ibm.commerce.user.beans.UserRegistrationSmartDataBean
        Returns:
        The user's login Id
      • getLogonIdURL

        public java.lang.String getLogonIdURL()
        Gets the name of LogonId URL parameter.
        Specified by:
        getLogonIdURL in interface com.ibm.commerce.user.beans.UserRegistrationSmartDataBean
        Returns:
        The name of LogonId URL parameter
      • getLogonPassword

        public java.lang.String getLogonPassword()
        Gets the user's logon password (encrypted).
        Specified by:
        getLogonPassword in interface com.ibm.commerce.user.beans.UserRegistrationSmartDataBean
        Returns:
        The logon password (encrypted)
      • getLogonPasswordURL

        public java.lang.String getLogonPasswordURL()
        Gets the name of LogonPassword URL parameter.
        Specified by:
        getLogonPasswordURL in interface com.ibm.commerce.user.beans.UserRegistrationSmartDataBean
        Returns:
        The name of LogonPassword URL parameter
      • getLogonPasswordVerifyURL

        public java.lang.String getLogonPasswordVerifyURL()
        Gets the name of LogonPasswordVerify URL parameter.
        Specified by:
        getLogonPasswordVerifyURL in interface com.ibm.commerce.user.beans.UserRegistrationSmartDataBean
        Returns:
        The name of LogonPasswordVerify URL parameter
      • getManager

        public java.lang.String getManager()
        Gets business user's manager's name.
        Specified by:
        getManager in interface com.ibm.commerce.user.beans.UserRegistrationSmartDataBean
        Returns:
        The name of manager
      • getManagerURL

        public java.lang.String getManagerURL()
        Gets the name of Manager URL parameter.
        Specified by:
        getManagerURL in interface com.ibm.commerce.user.beans.UserRegistrationSmartDataBean
        Returns:
        The name of Manager URL parameter
      • getMaritalStatus

        public java.lang.String getMaritalStatus()
        Gets the Marital Status associated with this user.
        Specified by:
        getMaritalStatus in interface com.ibm.commerce.user.beans.UserRegistrationSmartDataBean
        Returns:
        The marital status value For example:
        • S - Single
        • M - Married
        • C - Common Law
        • P - Separated
        • D - Divorced
        • W - Widowed
        • O - Other
        • N - Not Provided
      • getMaritalStatusURL

        public java.lang.String getMaritalStatusURL()
        Gets the name of MaritalStatus URL parameter.
        Specified by:
        getMaritalStatusURL in interface com.ibm.commerce.user.beans.UserRegistrationSmartDataBean
        Returns:
        The name of MaritalStatus URL parameter
      • getMemberId

        public java.lang.String getMemberId()
        Get the memberId This method is deprecated. getUserId() should be used instead.
        Returns:
        The memberId
      • getMiddleName

        public java.lang.String getMiddleName()
        Gets the middle name of the individual.
        Specified by:
        getMiddleName in interface com.ibm.commerce.user.beans.UserRegistrationSmartDataBean
        Returns:
        The middle name
      • getMiddleNameURL

        public java.lang.String getMiddleNameURL()
        Gets the name of MiddleName URL parameter.
        Specified by:
        getMiddleNameURL in interface com.ibm.commerce.user.beans.UserRegistrationSmartDataBean
        Returns:
        The name of MiddleName URL parameter
      • getNickName

        public java.lang.String getNickName()
        Gets the nick name of the registration address.
        Specified by:
        getNickName in interface com.ibm.commerce.user.beans.UserRegistrationSmartDataBean
        Returns:
        The nick name of the registration address
      • getNickNameURL

        public java.lang.String getNickNameURL()
        Gets the name of NickName URL parameter.
        Specified by:
        getNickNameURL in interface com.ibm.commerce.user.beans.UserRegistrationSmartDataBean
        Returns:
        The name of NickName URL parameter
      • getNumberOfChildren

        public java.lang.String getNumberOfChildren()
        Gets number of children.
        Specified by:
        getNumberOfChildren in interface com.ibm.commerce.user.beans.UserRegistrationSmartDataBean
        Returns:
        The number of children
      • getNumberOfChildrenURL

        public java.lang.String getNumberOfChildrenURL()
        Gets the name of NumberOfChildren url parameter.
        Specified by:
        getNumberOfChildrenURL in interface com.ibm.commerce.user.beans.UserRegistrationSmartDataBean
        Returns:
        The name of NumberOfChildren url parameter
      • getOfficeAddress

        public java.lang.String getOfficeAddress()
        Gets number of children.
        Specified by:
        getOfficeAddress in interface com.ibm.commerce.user.beans.UserRegistrationSmartDataBean
        Returns:
        The number of children
      • getOfficeAddressURL

        public java.lang.String getOfficeAddressURL()
        Gets the name of OfficeAddress URL parameter.
        Specified by:
        getOfficeAddressURL in interface com.ibm.commerce.user.beans.UserRegistrationSmartDataBean
        Returns:
        The name of OfficeAddress URL parameter
      • getOrganizationId

        public java.lang.String getOrganizationId()
        Gets the identifies the Organization to which this business profile is associated with (BUSPROF table). Foreign key to the ORGENTITY table.
        Specified by:
        getOrganizationId in interface com.ibm.commerce.user.beans.UserRegistrationSmartDataBean
        Returns:
        The identifies the Organization to which this business profile is associated with
      • getOrganizationIdURL

        public java.lang.String getOrganizationIdURL()
        Gets the name of OrganizationId URL parameter.
        Specified by:
        getOrganizationIdURL in interface com.ibm.commerce.user.beans.UserRegistrationSmartDataBean
        Returns:
        The name of OrganizationId URL parameter
      • getOrganizationList

        public java.lang.String[][] getOrganizationList()
        Returns a two dimension String array which contains all organizations information in the ORGENTITY table. First column: Organization Ids (ORGENTITY Table) Second column: Organization Names (ORGENTITY Table)
        Specified by:
        getOrganizationList in interface com.ibm.commerce.user.beans.UserRegistrationSmartDataBean
        Returns:
        String[][] A two dimension String array which contains all organization information in the ORGENTITY table. Returns null if an Exception is caught.
      • getOrganizationName

        public java.lang.String getOrganizationName()
        Gets the identifies the Organization to which this business profile is associated with (BUSPROF table). Foreign key to the ORGENTITY table.
        Specified by:
        getOrganizationName in interface com.ibm.commerce.user.beans.UserRegistrationSmartDataBean
        Returns:
        The identifies the Organization to which this business profile is associated with
      • getOrganizationNameURL

        public java.lang.String getOrganizationNameURL()
        Gets the name of OrganizationName URL parameter.
        Specified by:
        getOrganizationNameURL in interface com.ibm.commerce.user.beans.UserRegistrationSmartDataBean
        Returns:
        The name of OrganizationName URL parameter
      • getOrganizationUnitId

        public java.lang.String getOrganizationUnitId()
        Gets the identifies the Organization to which this business profile is associated with (BUSPROF table). Foreign key to the ORGENTITY table.
        Specified by:
        getOrganizationUnitId in interface com.ibm.commerce.user.beans.UserRegistrationSmartDataBean
        Returns:
        The identifies the Organization to which this business profile is associated with
      • getOrganizationUnitIdURL

        public java.lang.String getOrganizationUnitIdURL()
        Gets the name of OrganizationUnitId URL parameter.
        Specified by:
        getOrganizationUnitIdURL in interface com.ibm.commerce.user.beans.UserRegistrationSmartDataBean
        Returns:
        The name of OrganizationUnitId URL parameter
      • getOrganizationUnitList

        public java.lang.String[][] getOrganizationUnitList()
        Return a two dimension String array which contains all organizational units information in the ORGENTITY table First column: Organizational Unit Ids (ORGENTITY Table) Second column: Organizational Unit Names (ORGENTITY Table)
        Specified by:
        getOrganizationUnitList in interface com.ibm.commerce.user.beans.UserRegistrationSmartDataBean
        Returns:
        String[][] A two dimension String array which contains all organizational units information in the ORGENTITY table. Returns null if an Exception is caught.
      • getOrganizationUnitName

        public java.lang.String getOrganizationUnitName()
        Gets the identifies the Organization to which this business profile is associated with (BUSPROF table). Foreign key to the ORGENTITY table.
        Specified by:
        getOrganizationUnitName in interface com.ibm.commerce.user.beans.UserRegistrationSmartDataBean
        Returns:
        The identifies the Organization to which this business profile is associated with
      • getOrganizationUnitNameURL

        public java.lang.String getOrganizationUnitNameURL()
        Gets the name of OrganizationUnitName URL parameter.
        Specified by:
        getOrganizationUnitNameURL in interface com.ibm.commerce.user.beans.UserRegistrationSmartDataBean
        Returns:
        The name of OrganizationUnitName URL parameter
      • getOrgEntityListUserAdmin

        public java.util.Vector getOrgEntityListUserAdmin()
        Gets the top level organizations found in the getOrgEntityUserAdmin method, along with their descendant organizations.
        Returns:
        the top level organization IDs (String) found in the getOrgEntityUserAdmin method, along with their descendant organization IDs.
      • getTopLevelOrganizationsDirectlyAdministered

        public java.util.Vector getTopLevelOrganizationsDirectlyAdministered()
        Get all the top-level organization IDs where this user has the authority to perform "OrganizationManage":

        Returns:
        a vector of top level organization IDs (String) that this user is directly administering. If the user is a Site Administrator, the vector will simply contain "-2001" (Root Organization).
      • getOrgEntityUserAdmin

        public java.util.Vector getOrgEntityUserAdmin()
        Get all the top-level organization IDs where this user has the authority to perform "OrganizationManage":

      • 1. The organizations where the user directly has a necessary role.
      • 2. The organizations that are direct members of a RegisteredCustomers member group owned by organizations from #1.
      • 3. The organizations that are direct members of a RegisteredCustomers member group owned by a descendant of an organization from #1.
Returns:
a vector of top level organization IDs (String) that this user is directly administering, as well as the top level organizations in the associated RegisteredCustomer member groups. If the user is a Site Administrator, the vector will simply contain "-2001" (Root Organization).
  • getPackageSuppression

    public java.lang.String getPackageSuppression()
    Gets the package suppression attribute for this user.
    Specified by:
    getPackageSuppression in interface com.ibm.commerce.user.beans.UserRegistrationSmartDataBean
    Returns:
    The value of the package suppression attribute for this user.
  • getPackageSuppressionURL

    public java.lang.String getPackageSuppressionURL()
    Gets the name of PackageSuppression URL parameter.
    Specified by:
    getPackageSuppressionURL in interface com.ibm.commerce.user.beans.UserRegistrationSmartDataBean
    Returns:
    The name of PackageSuppression URL parameter
  • getParentMember

    public java.lang.String getParentMember()
    Get the Distinguished Name of the parent orgentity.
    Specified by:
    getParentMember in interface com.ibm.commerce.user.beans.UserRegistrationSmartDataBean
    Returns:
    The Distinguished Name of the parent orgentity
  • getParentMemberId

    public java.lang.String getParentMemberId()
    Gets the memberId of the parent orgentity.
    Specified by:
    getParentMemberId in interface com.ibm.commerce.user.beans.UserRegistrationSmartDataBean
    Returns:
    The memberId of the parent orgentity
  • getParentMemberIdURL

    public java.lang.String getParentMemberIdURL()
    Gets the name of ParentMemberId URL parameter.
    Returns:
    The name of ParentMemberId URL parameter
  • getParentMemberURL

    public java.lang.String getParentMemberURL()
    Gets the name of ParentMember URL parameter.
    Returns:
    The name of ParentMember URL parameter
  • getPersonTitle

    public java.lang.String getPersonTitle()
    Gets the title of the person to which this address applies.
    Specified by:
    getPersonTitle in interface com.ibm.commerce.user.beans.UserRegistrationSmartDataBean
    Returns:
    The person title For example:
    • N - Not provided (default)
    • Mr - Mr.
    • Mrs - Mrs.
    • Ms - Ms.
    • Dr - Dr.
    • Prof- Prof.
  • getPersonTitleURL

    public java.lang.String getPersonTitleURL()
    Gets the name of PersonTitle URL parameter.
    Specified by:
    getPersonTitleURL in interface com.ibm.commerce.user.beans.UserRegistrationSmartDataBean
    Returns:
    The name of PersonTitle URL parameter
  • getPhone1

    public java.lang.String getPhone1()
    Gets the number of phone 1.
    Specified by:
    getPhone1 in interface com.ibm.commerce.user.beans.UserRegistrationSmartDataBean
    Returns:
    the number of phone 1
  • getPhone1Type

    public java.lang.String getPhone1Type()
    Gets the type of the phone 1.
    Specified by:
    getPhone1Type in interface com.ibm.commerce.user.beans.UserRegistrationSmartDataBean
    Returns:
    The type of phone1 For Example:
    • PHN - standard phone
    • TTY - teletypewriter for people who have a hearing impairment
  • getPhone1TypeURL

    public java.lang.String getPhone1TypeURL()
    Gets the name of Phone1Type URL parameter.
    Specified by:
    getPhone1TypeURL in interface com.ibm.commerce.user.beans.UserRegistrationSmartDataBean
    Returns:
    The name of Phone1Type URL parameter
  • getPhone1URL

    public java.lang.String getPhone1URL()
    Gets the name of Phone1 URL parameter.
    Specified by:
    getPhone1URL in interface com.ibm.commerce.user.beans.UserRegistrationSmartDataBean
    Returns:
    The name of Phone1 URL parameter
  • getPhone2

    public java.lang.String getPhone2()
    Gets the number of phone 2.
    Specified by:
    getPhone2 in interface com.ibm.commerce.user.beans.UserRegistrationSmartDataBean
    Returns:
    the number of phone 2
  • getPhone2Type

    public java.lang.String getPhone2Type()
    Gets the type of the phone 2.
    Specified by:
    getPhone2Type in interface com.ibm.commerce.user.beans.UserRegistrationSmartDataBean
    Returns:
    The type of phone2 For Example:
    • PHN - standard phone
    • TTY - teletypewriter for people who have a hearing impairment
  • getPhone2TypeURL

    public java.lang.String getPhone2TypeURL()
    Gets the name of Phone2Type URL parameter.
    Specified by:
    getPhone2TypeURL in interface com.ibm.commerce.user.beans.UserRegistrationSmartDataBean
    Returns:
    The name of Phone2Type URL parameter
  • getPhone2URL

    public java.lang.String getPhone2URL()
    Gets the name of Phone2 URL parameter.
    Specified by:
    getPhone2URL in interface com.ibm.commerce.user.beans.UserRegistrationSmartDataBean
    Returns:
    The name of Phone2 URL parameter
  • getPhoto

    public java.lang.String getPhoto()
    Gets the URL or path to the photo of the user.
    Specified by:
    getPhoto in interface com.ibm.commerce.user.beans.UserRegistrationSmartDataBean
    Returns:
    The URL or path to the photo of the user
  • getPhotoURL

    public java.lang.String getPhotoURL()
    Gets the name of Photo URL parameter.
    Specified by:
    getPhotoURL in interface com.ibm.commerce.user.beans.UserRegistrationSmartDataBean
    Returns:
    The name of Photo URL parameter
  • getPreferredCommunication

    public java.lang.String getPreferredCommunication()
    Gets the preferred method of communication.
    Specified by:
    getPreferredCommunication in interface com.ibm.commerce.user.beans.UserRegistrationSmartDataBean
    Returns:
    The preferred method of communication
  • getPreferredCommunicationURL

    public java.lang.String getPreferredCommunicationURL()
    Gets the name of PreferredCommunication URL parameter.
    Specified by:
    getPreferredCommunicationURL in interface com.ibm.commerce.user.beans.UserRegistrationSmartDataBean
    Returns:
    The name of PreferredCommunication URL parameter
  • getPreferredCurrency

    public java.lang.String getPreferredCurrency()
    Sets the preferred currency in 3-character alphabetic code as per ISO 4217. Foreign key to SETCURR table.
    Specified by:
    getPreferredCurrency in interface com.ibm.commerce.user.beans.UserRegistrationSmartDataBean
    Returns:
    The preferred currency
  • getPreferredCurrencyURL

    public java.lang.String getPreferredCurrencyURL()
    Gets the name of PreferredCurrency URL parameter.
    Specified by:
    getPreferredCurrencyURL in interface com.ibm.commerce.user.beans.UserRegistrationSmartDataBean
    Returns:
    The name of PreferredCurrency URL parameter
  • getPreferredDelivery

    public java.lang.String getPreferredDelivery()
    Gets the preferred delivery method (USERPROF table).
    Specified by:
    getPreferredDelivery in interface com.ibm.commerce.user.beans.UserRegistrationSmartDataBean
    Returns:
    The preferred delivery method.
  • getPreferredDeliveryURL

    public java.lang.String getPreferredDeliveryURL()
    Gets the name of PreferredDelivery URL parameter.
    Specified by:
    getPreferredDeliveryURL in interface com.ibm.commerce.user.beans.UserRegistrationSmartDataBean
    Returns:
    The name of PreferredDelivery URL parameter
  • getPreferredLanguage

    public java.lang.String getPreferredLanguage()
    Gets the preferred language. Foreign key relationship to LANGUAGE table.
    Specified by:
    getPreferredLanguage in interface com.ibm.commerce.user.beans.UserRegistrationSmartDataBean
    Returns:
    The preferred language
  • getPreferredLanguageId

    public java.lang.String getPreferredLanguageId()
    Gets the preferred language. Foreign key relationship to LANGUAGE table. This method is deprecated. getPreferredLanguage() method should be used instead.
    Returns:
    The preferred language
  • getPreferredLanguageIdURL

    public java.lang.String getPreferredLanguageIdURL()
    Gets the name of PreferredLanguage URL parameter. This method is deprecated. getPreferredLanguageIdURL() method should be used instead.
    Returns:
    The name of PreferredLanguage URL parameter
  • getPreferredLanguageURL

    public java.lang.String getPreferredLanguageURL()
    Gets the name of PreferredLanguage URL parameter.
    Specified by:
    getPreferredLanguageURL in interface com.ibm.commerce.user.beans.UserRegistrationSmartDataBean
    Returns:
    The name of PreferredLanguage URL parameter
  • getPreferredMeasure

    public java.lang.String getPreferredMeasure()
    Gets the preferred measurement system.
    Specified by:
    getPreferredMeasure in interface com.ibm.commerce.user.beans.UserRegistrationSmartDataBean
    Returns:
    The preferred measurement system
  • getPreferredMeasureURL

    public java.lang.String getPreferredMeasureURL()
    Gets the name of PreferredMeasure URL parameter.
    Specified by:
    getPreferredMeasureURL in interface com.ibm.commerce.user.beans.UserRegistrationSmartDataBean
    Returns:
    The name of PreferredMeasure URL parameter
  • getPreviousLastSession

    public java.lang.String getPreviousLastSession()
    Get the date and time when the user previous last visited the WCS site. Last visited means last logon to the WCS site .
    Returns:
    The data and time when the user previous last visited
  • getPreviousLastSessionURL

    public java.lang.String getPreviousLastSessionURL()
    Gets the name of PreviousLastSession URL parameter.
    Returns:
    The name of PreviousLastSession URL parameter
  • getPrimary

    public java.lang.String getPrimary()
    Gets an integer indicating whether the address is a primary address. This allows multiple addresses for each address type. (eg. Multiple billing addresses, multiple shipping addresses) and one of them to be designated as the 'primary billing address', 'primary shipping address', and so forth. Each address type can have one or none primary address.
    Specified by:
    getPrimary in interface com.ibm.commerce.user.beans.UserRegistrationSmartDataBean
    Returns:
    An integer indicating whether the address is a primary address
    • 1 - primary (or default) address
    • 0 - not primary address
  • getPrimaryURL

    public java.lang.String getPrimaryURL()
    Gets the name of Primary URL parameter.
    Specified by:
    getPrimaryURL in interface com.ibm.commerce.user.beans.UserRegistrationSmartDataBean
    Returns:
    The name of Primary URL parameter
  • getProfileType

    public java.lang.String getProfileType()
    Gets the type of profile this user has.
    Specified by:
    getProfileType in interface com.ibm.commerce.user.beans.UserRegistrationSmartDataBean
    Returns:
    The profile type
    • C - customer profile
    • B - business profile
  • getProfileTypeURL

    public java.lang.String getProfileTypeURL()
    Gets the name of Profile Type URL parameter.
    Specified by:
    getProfileTypeURL in interface com.ibm.commerce.user.beans.UserRegistrationSmartDataBean
    Returns:
    The name of Profile Type URL parameter
  • getPublishPhone1

    public java.lang.String getPublishPhone1()
    Gets an integer indicating whether or not to publish the number of phone 1.
    Specified by:
    getPublishPhone1 in interface com.ibm.commerce.user.beans.UserRegistrationSmartDataBean
    Returns:
    An integer indicating whether or not to publish the number of phone 1
    • 1 - to publish the number of phone 1
    • 0 - not to publish the number of phone 1
  • getPublishPhone1URL

    public java.lang.String getPublishPhone1URL()
    Gets the name of the Publish Phone 1 URL parameter.
    Specified by:
    getPublishPhone1URL in interface com.ibm.commerce.user.beans.UserRegistrationSmartDataBean
    Returns:
    The name of Publish Phone 1 URL parameter
  • getPublishPhone2

    public java.lang.String getPublishPhone2()
    Gets an integer indicating whether or not to publish the number of phone 2.
    Specified by:
    getPublishPhone2 in interface com.ibm.commerce.user.beans.UserRegistrationSmartDataBean
    Returns:
    An integer indicating whether or not to publish the number of phone 2
    • 1 - to publish the number of phone 2
    • 0 - not to publish the number of phone 2
  • getPublishPhone2URL

    public java.lang.String getPublishPhone2URL()
    Gets the name of Publish Phone 2 URL parameter.
    Specified by:
    getPublishPhone2URL in interface com.ibm.commerce.user.beans.UserRegistrationSmartDataBean
    Returns:
    The name of Publish Phone 2 URL parameter
  • getReceiveSMSNotification

    public java.lang.String getReceiveSMSNotification()
    Gets the receive SMS notification method (USERPROF table).
    Specified by:
    getReceiveSMSNotification in interface com.ibm.commerce.user.beans.UserRegistrationSmartDataBean
    Returns:
    The receive SMS notification method.
  • getReceiveSMSNotificationURL

    public java.lang.String getReceiveSMSNotificationURL()
    Gets the name of ReceiveSMSNotification URL parameter.
    Specified by:
    getReceiveSMSNotificationURL in interface com.ibm.commerce.user.beans.UserRegistrationSmartDataBean
    Returns:
    The name of ReceiveSMSNotification URL parameter
  • getRegisterType

    public java.lang.String getRegisterType()
    Gets the registration type of this user.
    Specified by:
    getRegisterType in interface com.ibm.commerce.user.beans.UserRegistrationSmartDataBean
    Returns:
    The registration type
    • G - Guest User (a user who does not provide any profile information)
    • R - Registered User (a user who provides profile information)
    • A - Administrator (registered and an administrator)
    • S - Site Administrator (super user)
  • getRegisterTypeURL

    public java.lang.String getRegisterTypeURL()
    Gets the name of Register Type URL parameter.
    Specified by:
    getRegisterTypeURL in interface com.ibm.commerce.user.beans.UserRegistrationSmartDataBean
    Returns:
    The name of Register Type URL parameter
  • getRegistration

    public java.lang.String getRegistration()
    Gets the data and time when registration happened.
    Returns:
    The data and time when registration happened
  • getRegistrationCancel

    public java.lang.String getRegistrationCancel()
    Gets the data and time when registration was canceled.
    Returns:
    The data and time when registration was canceled
  • getRegistrationCancelTime

    public java.lang.String getRegistrationCancelTime()
    Gets the data and time when registration was canceled.
    Specified by:
    getRegistrationCancelTime in interface com.ibm.commerce.user.beans.UserRegistrationSmartDataBean
    Returns:
    The data and time when registration was canceled
  • getRegistrationCancelTimeURL

    public java.lang.String getRegistrationCancelTimeURL()
    Gets the name of Registration Cancel Time URL parameter.
    Specified by:
    getRegistrationCancelTimeURL in interface com.ibm.commerce.user.beans.UserRegistrationSmartDataBean
    Returns:
    The name of Registration Cancel Time URL parameter
  • getRegistrationCancelURL

    public java.lang.String getRegistrationCancelURL()
    Gets the name of Registration Cancel URL parameter.
    Returns:
    The name of Registration Cancel URL parameter
  • getRegistrationTime

    public java.lang.String getRegistrationTime()
    Gets the data and time when registration happened.
    Specified by:
    getRegistrationTime in interface com.ibm.commerce.user.beans.UserRegistrationSmartDataBean
    Returns:
    The data and time when registration happened
  • getRegistrationTimeURL

    public java.lang.String getRegistrationTimeURL()
    Gets the name of RegisterType URL parameter.
    Specified by:
    getRegistrationTimeURL in interface com.ibm.commerce.user.beans.UserRegistrationSmartDataBean
    Returns:
    The name of RegisterType URL parameter
  • getRegistrationUpdate

    public java.lang.String getRegistrationUpdate()
    Gets the data and time when the registration information was last updated.
    Returns:
    The data and time when the registration information was last updated.
  • getRegistrationUpdateTime

    public java.lang.String getRegistrationUpdateTime()
    Gets the data and time when the registration information was last updated.
    Specified by:
    getRegistrationUpdateTime in interface com.ibm.commerce.user.beans.UserRegistrationSmartDataBean
    Returns:
    The data and time when the registration information was last updated.
  • getRegistrationUpdateTimeURL

    public java.lang.String getRegistrationUpdateTimeURL()
    Gets the name of RegistrationUpdateTime URL parameter.
    Specified by:
    getRegistrationUpdateTimeURL in interface com.ibm.commerce.user.beans.UserRegistrationSmartDataBean
    Returns:
    The name of RegistrationUpdateTime URL parameter
  • getRegistrationUpdateURL

    public java.lang.String getRegistrationUpdateURL()
    Gets the name of RegistrationUpdate URL parameter.
    Returns:
    The name of RegistrationUpdate URL parameter
  • getRegistrationURL

    public java.lang.String getRegistrationURL()
    Gets the name of Registration URL parameter.
    Returns:
    The name of Registration URL parameter
  • getRequestProperties

    public TypedProperty getRequestProperties()
    Get the request properties.
    Specified by:
    getRequestProperties in interface InputDataBean
    Specified by:
    getRequestProperties in interface com.ibm.commerce.user.beans.UserRegistrationSmartDataBean
    Returns:
    TypedProperty The request properties.
  • getRoles

    public java.lang.Integer[] getRoles()
    Get all roles played by this user.
    Specified by:
    getRoles in interface com.ibm.commerce.user.beans.UserRegistrationSmartDataBean
    Returns:
    All roles played by this user.
  • getRolesWithDetails

    public RoleDataBean[] getRolesWithDetails()
    Get all roles with detail information played by this user.
    Returns:
    All roles with details played by this user.
  • getRoles

    public java.lang.Integer[] getRoles(java.lang.String astrOrgEntityId)
    Get all roles played by this user in the specified organization or organizational unit.
    Parameters:
    astrOrgEntityId - The OrgEntityId of the specified organization or organizational unit
    Returns:
    All roles played by this user in the specified organization or organizational unit
  • getRolesInActiveOrganization

    public java.lang.Integer[] getRolesInActiveOrganization()
    Get all roles played by this user in the active organization.
    Returns:
    All roles played by this user in the active organization
    See Also:
    CommandContext.getActiveOrganizationId()
  • getRolesForOrgEntityAndAncestors

    public java.lang.Integer[] getRolesForOrgEntityAndAncestors(java.lang.String astrOrgEntityId)
    Get all roles assigned to this user for the specified orgEntity and all of its ancestor orgentities.
    Parameters:
    astrOrgEntityId - The OrgEntityId of the specified organization or organizational unit
    Returns:
    All roles assigned to this user for the specified orgEntity and all of its ancestor orgentities
  • getRolesInActiveOrganizationAndAncestors

    public java.lang.Integer[] getRolesInActiveOrganizationAndAncestors()
    Get all roles played by this user in the active organization and its ancestor organizations.
    Returns:
    All roles played by this user in the active organization and its ancestor organizations
    See Also:
    CommandContext.getActiveOrganizationId()
  • getSecretary

    public java.lang.String getSecretary()
    Gets business user's secretary's name
    Specified by:
    getSecretary in interface com.ibm.commerce.user.beans.UserRegistrationSmartDataBean
    Returns:
    The name of the secretary
  • getSecretaryURL

    public java.lang.String getSecretaryURL()
    Gets the name of Secretary URL parameter.
    Specified by:
    getSecretaryURL in interface com.ibm.commerce.user.beans.UserRegistrationSmartDataBean
    Returns:
    The name of Secretary URL parameter
  • getSortedCurrencyList

    public java.lang.String[][] getSortedCurrencyList()
    Return a two dimension String array which contains all currency information in the SETCUR table sorted in alphabetically order of the currency description. First column: Currency Code (SETCURR Table) Second column: Currency Name (SETCURR Table) This method is deprecated. CurrentListDataBean should be used instead.
    Specified by:
    getSortedCurrencyList in interface com.ibm.commerce.user.beans.UserRegistrationSmartDataBean
    Returns:
    String[][] Two dimension String array which contains currency code and currency name from SETCURR tables sorted in alphabetically order of the currency description.
  • getSortedLanguageList

    public java.lang.String[][] getSortedLanguageList()
    Return a two dimension String array which contains all language information in the LANGUAGE and LANGUAGEDS tables sorted in alphabetically order of the language description. First column: Language Ids (LANGUAGE Table) Second column: Language Descriptions (LANGUAGEDS Table) This method is deprecated. LanguageListDataBean should be used instead.
    Specified by:
    getSortedLanguageList in interface com.ibm.commerce.user.beans.UserRegistrationSmartDataBean
    Returns:
    String[][] A two dimension String array which contains languages ids and languages descriptions from the LANGUAGE and LANGUAGEDS tables. The elements are sorted in alphabetically order of the language description.
  • getState

    public java.lang.String getState()
    Gets the name of the state, province, or equivalent where the individual resides.
    Specified by:
    getState in interface com.ibm.commerce.user.beans.UserRegistrationSmartDataBean
    Returns:
    The name of the state
  • getStateURL

    public java.lang.String getStateURL()
    Gets the name of State URL parameter.
    Specified by:
    getStateURL in interface com.ibm.commerce.user.beans.UserRegistrationSmartDataBean
    Returns:
    The name of State URL parameter
  • getStoreDirectory

    public java.lang.String getStoreDirectory()
    Gets the name of the store directory, which is used in getUserRegistrationProperties for the path to the property file. This method is deprecated. ResourceBundleDataBean should be used instead.
    Specified by:
    getStoreDirectory in interface com.ibm.commerce.user.beans.UserRegistrationSmartDataBean
    Returns:
    The name of the store directory
  • getStoreIdURL

    public java.lang.String getStoreIdURL()
    Gets the name of StoreId URL parameter.
    Specified by:
    getStoreIdURL in interface com.ibm.commerce.user.beans.UserRegistrationSmartDataBean
    Returns:
    The name of StoreId URL parameter
  • getType

    public java.lang.String getType()
    Get the type of the member.
    Returns:
    The type of the member
  • getUrlURL

    public java.lang.String getUrlURL()
    Gets the name of URL parameter: Url.
    Specified by:
    getUrlURL in interface com.ibm.commerce.user.beans.UserRegistrationSmartDataBean
    Returns:
    The name of URL parameter: Url.
  • getUserField1

    public java.lang.String getUserField1()
    Gets user field 1 reserved for customization (USERS table).
    Specified by:
    getUserField1 in interface com.ibm.commerce.user.beans.UserRegistrationSmartDataBean
    Returns:
    Customizable user field 1
  • getUserField1URL

    public java.lang.String getUserField1URL()
    Gets the name of UserField1 URL parameter.
    Specified by:
    getUserField1URL in interface com.ibm.commerce.user.beans.UserRegistrationSmartDataBean
    Returns:
    The name of UserField1 URL parameter
  • getUserField2

    public java.lang.String getUserField2()
    Gets user field 2 reserved for customization (USERS table).
    Specified by:
    getUserField2 in interface com.ibm.commerce.user.beans.UserRegistrationSmartDataBean
    Returns:
    Customizable user field 2
  • getUserField2URL

    public java.lang.String getUserField2URL()
    Gets the name of UserField2 URL parameter.
    Specified by:
    getUserField2URL in interface com.ibm.commerce.user.beans.UserRegistrationSmartDataBean
    Returns:
    The name of UserField2 URL parameter
  • getUserField3

    public java.lang.String getUserField3()
    Gets user field 3 reserved for customization (USERS table).
    Specified by:
    getUserField3 in interface com.ibm.commerce.user.beans.UserRegistrationSmartDataBean
    Returns:
    Customizable user field 3
  • getUserField3URL

    public java.lang.String getUserField3URL()
    Gets the name of UserField3 URL parameter.
    Specified by:
    getUserField3URL in interface com.ibm.commerce.user.beans.UserRegistrationSmartDataBean
    Returns:
    The name of UserField3 URL parameter
  • getUserId

    public java.lang.String getUserId()
    Gets the userId
    Specified by:
    getUserId in interface com.ibm.commerce.user.beans.UserRegistrationSmartDataBean
    Returns:
    The userId
  • getUserProfile

    public UserProfileAccessBean getUserProfile()
    Gets the UserProfileAccessBean of this member.
    Specified by:
    getUserProfile in interface com.ibm.commerce.user.beans.UserRegistrationSmartDataBean
    Returns:
    The UserProfileAccessBean of this member
  • getUserProfileField1

    public java.lang.String getUserProfileField1()
    Gets user profile field 1 reserved for customization (USERPROF table).
    Specified by:
    getUserProfileField1 in interface com.ibm.commerce.user.beans.UserRegistrationSmartDataBean
    Returns:
    user profile field 1 reserved for customization
  • getUserProfileField1URL

    public java.lang.String getUserProfileField1URL()
    Gets the name of UserProfileField1 URL parameter.
    Specified by:
    getUserProfileField1URL in interface com.ibm.commerce.user.beans.UserRegistrationSmartDataBean
    Returns:
    The name of UserProfileField1 URL parameter
  • getUserProfileField2

    public java.lang.String getUserProfileField2()
    Gets user profile field 2 reserved for customization (USERPROF table).
    Specified by:
    getUserProfileField2 in interface com.ibm.commerce.user.beans.UserRegistrationSmartDataBean
    Returns:
    user profile field 2 reserved for customization
  • getUserProfileField2URL

    public java.lang.String getUserProfileField2URL()
    Gets the name of UserProfileField2 URL parameter.
    Specified by:
    getUserProfileField2URL in interface com.ibm.commerce.user.beans.UserRegistrationSmartDataBean
    Returns:
    The name of UserProfileField2 URL parameter
  • getZipCode

    public java.lang.String getZipCode()
    Gets the zip code or equivalent postal code of the individual's address.
    Specified by:
    getZipCode in interface com.ibm.commerce.user.beans.UserRegistrationSmartDataBean
    Returns:
    The zip code
  • getZipCodeURL

    public java.lang.String getZipCodeURL()
    Gets the name of ZipCode URL parameter.
    Specified by:
    getZipCodeURL in interface com.ibm.commerce.user.beans.UserRegistrationSmartDataBean
    Returns:
    The name of ZipCode URL parameter
  • isMemberInRole

    public boolean isMemberInRole(java.lang.String astrRoleName)
    Gets a boolean value which indicates whether this user plays the specified role.
    Specified by:
    isMemberInRole in interface com.ibm.commerce.user.beans.UserRegistrationSmartDataBean
    Parameters:
    astrRoleName - The name of the role
    Returns:
    A boolean value which indicates whether this user plays the specified role
  • isMemberInRole

    public boolean isMemberInRole(java.lang.String astrRoleName,
                                  java.lang.Long anOrgEntityId)
    Gets a boolean value which indicates whether this user plays the specified role in the specified organization or organizational unit.
    Specified by:
    isMemberInRole in interface com.ibm.commerce.user.beans.UserRegistrationSmartDataBean
    Parameters:
    astrRoleName - The name of the role
    anOrgEntityId - The OrgEntityId of the organization or organizational unit
    Returns:
    A boolean value which indicates whether this user plays the specified role
  • isMemberInRole

    public boolean isMemberInRole(java.lang.String astrRoleName,
                                  java.lang.String astrOrgEntityId)
    Gets a boolean value which indicates whether this user plays the specified role in the specified organization or organizational unit.
    Specified by:
    isMemberInRole in interface com.ibm.commerce.user.beans.UserRegistrationSmartDataBean
    Parameters:
    astrRoleName - The name of the role
    astrOrgEntityId - The OrgEntityId of the organization or organizational unit
    Returns:
    A boolean value which indicates whether this user plays the specified role
  • populate

    public void populate()
                  throws java.lang.Exception
    Activate the bean. Before activating the bean, you should ensure that the setCommandContext() method has been called.
    Specified by:
    populate in interface SmartDataBean
    Throws:
    java.lang.Exception
  • setCommandContext

    public void setCommandContext(CommandContext aCommandContext)
    Set the command context.
    Specified by:
    setCommandContext in interface SmartDataBean
    Parameters:
    aCommandContext - The command context.
  • setDataBeanKeyMemberId

    public void setDataBeanKeyMemberId(java.lang.String aUserId)
    Set the user Id.
    Parameters:
    aUserId - The user Id
  • setProfileType

    public void setProfileType(java.lang.String astrProfileType)
    Deprecated. since version 6.0. This method is not needed since getProfileType() retrieves its value from the user object, not the instance variable.
    Sets the profile type. Only 'C' (Base) and 'B'(Business) are allowed. All other values will set the profile type to 'C'.
    Specified by:
    setProfileType in interface com.ibm.commerce.user.beans.UserRegistrationInputDataBean
    Parameters:
    astrProfileType - The value for profile type.
  • setRequestProperties

    public void setRequestProperties(TypedProperty aRequestProperty)
    Set the request properties.
    Specified by:
    setRequestProperties in interface InputDataBean
    Parameters:
    aRequestProperty - The request properties.
  • setStoreDirectory

    public void setStoreDirectory(java.lang.String astrStoreDirectory)
    Sets the name of store directory, which is used as the path to find the property file in getUserRegistrationProperties method. This method is deprecated.
    Specified by:
    setStoreDirectory in interface com.ibm.commerce.user.beans.UserRegistrationInputDataBean
    Parameters:
    astrStoreDirectory - The name of store directory
  • setUserId

    public void setUserId(java.lang.String aUserId)
    Sets the key (user Id) of this data bean.
    Specified by:
    setUserId in interface com.ibm.commerce.user.beans.UserRegistrationInputDataBean
    Parameters:
    aUserId - The key of this data bean.
  • setUserId

    public void setUserId(java.lang.Long aUserId)
    Sets the key(user id) of this data bean.
    Parameters:
    aUserId - The key of this data bean.
  • setRetrieveProperties

    public void setRetrieveProperties(java.util.List propertyNames)
    Deprecated. in Version 6.0. This method is not needed since all the properties will be retrieved.
    Sets the property names need to retrieve. If not set, the data bean will retrieve all properties of this user. If set, the data bean will only retrieve the properties specified, which can improve performance.
    Parameters:
    propertyNames - The name of the properties need to retrieve.
  • getRetrieveProperties

    public java.util.List getRetrieveProperties()
    Deprecated. in Version 6.0. This method is not needed since all the properties will be retrieved.
    Gets a list of property names need to retrieve. If the list is null, the data bean will retrieve all properties of this user. If the list is not null, the data bean will only retrieve the properties specified, which can improve performance.
    Returns:
    The properties to retrieve.
  • setSearchCriteria

    public void setSearchCriteria(int searchType,
                                  java.lang.String searchString,
                                  int maxNumOfResult)
    To specify the search criteria option before invoking the method getOrgEntityListUserAdminWithSearchCriteria(). Please see the following details for proper usage.
    Parameters:
    searchType - specify the search criteria option, the valid options:
    0 - No criteria, it will search all eligible organizations that allow the current logon user to administrate.
    1 - Match case, beginning with.
    2 - Match case, containing.
    3 - Ignore case, beginning with.
    4 - Ignore case, containing.
    5 - Exact match.
    9 - To find out the total number of eligible organizations available for user to search. For caller program to find out the number of organizations, please use the method getNumberOfOrgsFromSearchResults() after invoking the search method getOrgEntityListUserAdminWithSearchCriteria().
    searchString - org name to be searched. If searchType = 0 or 9, this parameter will be ignored and not used.
    maxNumOfResult - the threshold of max. search results. For performance purpose, this number restricts the total number of search result items returns. If the number of organizations found from the search is greater than this maxNumOfResult value. Then the method getOrgEntityListUserAdminWithSearchCriteria() will return an empty vector object instead of filling up the resulting items. Caller program may examine this condition by using the method hasNumOfSearchResultsExceededMax(). If you specify '-1' or other negative values for this parameter, the max. search result threshold will not apply. This maxNumOfResult parameter does not apply if searchType is set to '9'.
  • setSearchCriteriaType

    public void setSearchCriteriaType(int searchType)
    To specify the search criteria option before invoking the method getOrgEntityListUserAdminWithSearchCriteria().
    Parameters:
    searchType - specify the search criteria option, the valid options:
    0 - No criteria, it will search all eligible organizations that allow the current logon user to administrate.
    1 - Match case, beginning with.
    2 - Match case, containing.
    3 - Ignore case, beginning with.
    4 - Ignore case, containing.
    5 - Exact match.
  • setSearchKeyword

    public void setSearchKeyword(java.lang.String searchString)
    To specify the search keyword string before invoking the method getOrgEntityListUserAdminWithSearchCriteria().
    Parameters:
    searchString - account name to be searched. If searchType = 0, this parameter will be ignored and not used.
  • setSearchMaxThreshold

    public void setSearchMaxThreshold(int maxNumOfResult)
    To specify the threshold of max. search results before invoking the method getOrgEntityListUserAdminWithSearchCriteria().
    Parameters:
    maxNumOfResult - the threshold of max, search results. For performance purpose, this number restricts the total number of search result items returns. If the number of organizations found from the search is greater than this maxNumOfResult value. Then the method getOrgEntityListUserAdminWithSearchCriteria() will return an empty vector object instead of filling up the resulting items. Caller program may examine this condition by using the method hasNumOfSearchResultsExceededMax(). If you specify '-1' or other negative values for this parameter, the max. search result threshold will not apply.
  • getSearchCriteriaType

    public int getSearchCriteriaType()
    Returns:
    the search criteria type, valid values are shown below: 0 - No criteria, it will search all organizations in system.
    1 - Match case, beginning with.
    2 - Match case, containing.
    3 - Ignore case, beginning with.
    4 - Ignore case, containing.
    5 - Exact match.
  • getSearchKeyword

    public java.lang.String getSearchKeyword()
    Returns:
    the search criteria keyword string
  • getSearchMaxThreshold

    public int getSearchMaxThreshold()
    Returns:
    the threshold of max. search results.
  • hasNumOfSearchResultsExceededMax

    public boolean hasNumOfSearchResultsExceededMax()
    To check the recent search results exceeding specified threshold.
    Returns:
    true if the number of organizations found from the recent search is greater than the specified threshold; false if the number of organizations found is equal or less than the specified threshold.
  • getOrgEntityListUserAdminWithSearchCriteria

    public java.util.Vector getOrgEntityListUserAdminWithSearchCriteria()
    Get all organizations that this user is an administrator for. The result will be stored in a vector of vector form. The outer vector is a list of organizations data, and the inner vector holds each organization data elements (organization ID and organization name). For the inner vector, the first element is an organization ID in Long data type, the second element is an organization name in String data type.
    Returns:
    All organizations that this user is an administrator for.
  • getUserProfileDataBean

    public UserProfileDataBean getUserProfileDataBean()
    Getter for the UserProfileDataBean for this user.
    Returns:
    The UserProfileDataBean for this user; null if this user has no user profile.
  • getUserRegistryDataBean

    public UserRegistryDataBean getUserRegistryDataBean()
    Getter for the UserRegistryDataBean for this user.
    Returns:
    The UserRegistryDataBean for this user; null if this user is a guest.
  • getSelfAddressDataBean

    public AddressDataBean getSelfAddressDataBean()
    Get the user's self address.
    Returns:
    The user's self address; null if undefined.
  • getAddressesForUser

    public java.util.ArrayList getAddressesForUser()
    Get the addresses for this user.
    Returns:
    The addresses for this user; empty list if cannot be resolved.