com.ibm.commerce.tools.optools.user.beans

Class UserSearchDataBean

  • All Implemented Interfaces:
    DataBean, InputDataBean, SmartDataBean, Delegator, Protectable, java.io.Serializable


    public class UserSearchDataBean
    extends com.ibm.commerce.tools.optools.user.beansrc.UserSearchDataBeanBase
    Performs user search based on the following search criteria:
    • logonId
    • firstName
    • lastName
    • phone
    • email
    • city
    • zip
    This bean will call UserSearchEngine to perform the search. The storeType is retrieved from Command Context and is also passed to UserSearchEngine. If the Command Context is not available, storeType="B2C" by default.
    See Also:
    Serialized Form
    • Field Detail

      • COPYRIGHT

        public static final java.lang.String COPYRIGHT
        IBM Copyright statement.
        See Also:
        Constant Field Values
      • CLASSNAME

        public static final java.lang.String CLASSNAME
        The class name.
        See Also:
        Constant Field Values
      • MATCHCASE_BEGINWITH

        public static final java.lang.String MATCHCASE_BEGINWITH
        Case sensitive; begins with
        See Also:
        Constant Field Values
      • MATCHCASE_CONTAINING

        public static final java.lang.String MATCHCASE_CONTAINING
        Case sensitive; contains
        See Also:
        Constant Field Values
      • IGNORECASE_BEGINWITH

        public static final java.lang.String IGNORECASE_BEGINWITH
        Case insensitive; begins with
        See Also:
        Constant Field Values
      • IGNORECASE_CONTAINING

        public static final java.lang.String IGNORECASE_CONTAINING
        Case insensitive; contains
        See Also:
        Constant Field Values
      • EXACT_MATCH

        public static final java.lang.String EXACT_MATCH
        Case sensitive; exact match
        See Also:
        Constant Field Values
      • IGNORECASE_EXACT_MATCH

        public static final java.lang.String IGNORECASE_EXACT_MATCH
        Case insensitive; exact match
        See Also:
        Constant Field Values
      • IGNORECASE_ENDS_WITH

        public static final java.lang.String IGNORECASE_ENDS_WITH
        Case insensitive; ends with
        See Also:
        Constant Field Values
      • MATCHCASE_ENDS_WITH

        public static final java.lang.String MATCHCASE_ENDS_WITH
        Case sensitive; ends with
        See Also:
        Constant Field Values
    • Constructor Detail

      • UserSearchDataBean

        public UserSearchDataBean()
        Default Construct
    • Method Detail

      • getAccountId

        public java.lang.String getAccountId()
        Gets the account Id.
        Returns:
        String The account Id.
      • getCity

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

        public java.lang.String getCitySearchType()
        Gets the city search type.
        Returns:
        String The city search type.
      • getEmail

        public java.lang.String getEmail()
        Gets the email1
        Returns:
        String The email1 search parameter.
      • getEmailSearchType

        public java.lang.String getEmailSearchType()
        Gets the email1 search type.
        Returns:
        String The email1 search type.
      • getFirstName

        public java.lang.String getFirstName()
        Gets the firstName
        Returns:
        String The firstName.
      • getFirstNameSearchType

        public java.lang.String getFirstNameSearchType()
        Gets the firstName search type.
        Returns:
        String The firstName search type.
      • getLastName

        public java.lang.String getLastName()
        Gets the lastName.
        Returns:
        String The lastName.
      • getLastNameSearchType

        public java.lang.String getLastNameSearchType()
        Gets the lastName search type.
        Returns:
        The lastName search type.
      • getListSize

        public java.lang.String getListSize()
        Gets the list size.
        Returns:
        String The list size.
      • getLogonId

        public java.lang.String getLogonId()
        Gets the logonId.
        Returns:
        String The logonId.
      • getLogonIdSearchType

        public java.lang.String getLogonIdSearchType()
        Gets the logonId search type.
        Returns:
        String The logonId search type.
      • getOrderBy

        public java.lang.String getOrderBy()
        Gets the orderBy parameter.
        Returns:
        String The orderBy parameter.
      • getOrgId

        public java.lang.String getOrgId()
        Gets the organization Id.
        Returns:
        String The organization Id.
      • getPhone

        public java.lang.String getPhone()
        Gets the phone number.
        Returns:
        String The phone number.
      • getPhoneSearchType

        public java.lang.String getPhoneSearchType()
        Gets the phone number search type.
        Returns:
        String The phone number search type.
      • getResultSize

        public java.lang.String getResultSize()
        Gets the result size.
        Returns:
        String The result size.
      • getRoleId

        public java.lang.String getRoleId()
        Gets the role Id.
        Returns:
        String The role Id.
      • getStartIndex

        public java.lang.String getStartIndex()
        Gets the start index.
        Returns:
        String The start index.
      • getStoreType

        public java.lang.String getStoreType()
        Gets the store type. Defaults to 'B2C'.
        Returns:
        String The store type.
      • getUserIds

        public java.util.Vector getUserIds()
        Gets the vector of userIds.
        Returns:
        Vector The userIds returned from the search.
      • getZip

        public java.lang.String getZip()
        Gets the zip code.
        Returns:
        String The zip code.
      • getZipSearchType

        public java.lang.String getZipSearchType()
        Gets the zip code search type.
        Returns:
        String The zip code search type.
      • populate

        public void populate()
                      throws java.lang.Exception
        Uses the UserSearchAccessBean to fetch the list of userIds from the database.
        Specified by:
        populate in interface SmartDataBean
        Overrides:
        populate in class SmartDataBeanImpl
        Throws:
        java.lang.Exception
      • setAccountId

        public void setAccountId(java.lang.String newAccountId)
        Sets the accountId.
        Parameters:
        newAccountId - String
      • setBusinessSearch

        public void setBusinessSearch()
        Sets the businessSearch indicator.
        Parameters:
        newZip - String
      • setCity

        public void setCity(java.lang.String newCity)
        Sets the city search term.
        Parameters:
        newCity - String
      • setCitySearchType

        public void setCitySearchType(java.lang.String newCitySearchType)
        Sets the city search type.
        Parameters:
        newCitySearchType - String
      • setCollaborativeSearch

        public void setCollaborativeSearch()
        Sets the Collaborative search indicator.
      • setEmail

        public void setEmail(java.lang.String newEmail)
        Sets the email search term.
        Parameters:
        newEmail - String
      • setEmailSearchType

        public void setEmailSearchType(java.lang.String newEmailSearchType)
        Sets the email search type.
        Parameters:
        newEmailSearchType - String
      • setFirstName

        public void setFirstName(java.lang.String newFirstName)
        Sets the first name search term.
        Parameters:
        newFirstName - String
      • setFirstNameSearchType

        public void setFirstNameSearchType(java.lang.String newFirstNameSearchType)
        Sets the first name search type.
        Parameters:
        newFirstNameSearchType - String
      • setLastName

        public void setLastName(java.lang.String newLastName)
        Sets the last name search term.
        Parameters:
        newLastName - String
      • setLastNameSearchType

        public void setLastNameSearchType(java.lang.String newLastNameSearchType)
        Sets the last name search type.
        Parameters:
        newLastNameSearchType - String
      • setListSize

        public void setListSize(java.lang.String newListSize)
        Sets the list size.
        Parameters:
        newListSize - String
      • setLogonId

        public void setLogonId(java.lang.String newLogonId)
        Sets the logonId search term.
        Parameters:
        newLogonId - String
      • setLogonIdSearchType

        public void setLogonIdSearchType(java.lang.String newLogonIdSearchType)
        Sets the logonId search type.
        Parameters:
        newLogonIdSearchType - String
      • setOrderBy

        public void setOrderBy(java.lang.String newOrderBy)
        Sets the orderBy variable.
        Parameters:
        newOrderBy - String
      • setOrgId

        public void setOrgId(java.lang.String newOrgId)
        Sets the orgId variable.
        Parameters:
        newOrgId - String
      • setPhone

        public void setPhone(java.lang.String newPhone)
        Sets the phone search term.
        Parameters:
        newPhone - String
      • setPhoneSearchType

        public void setPhoneSearchType(java.lang.String newPhoneSearchType)
        Sets the phone search type.
        Parameters:
        newPhoneSearchType - String
      • setRoleId

        public void setRoleId(java.lang.String newRoleId)
        Sets the roldId variable.
        Parameters:
        newRoleId - String
      • setStartIndex

        public void setStartIndex(java.lang.String newStartIndex)
        Sets the startIndex variable.
        Parameters:
        newStartIndex - String
      • setZip

        public void setZip(java.lang.String newZip)
        Sets the zip search term.
        Parameters:
        newZip - String
      • setZipSearchType

        public void setZipSearchType(java.lang.String newZipSearchType)
        Sets the zip search type.
        Parameters:
        newZipSearchType - String
      • setSearchType

        public void setSearchType(java.lang.String astrSearchType)
        Sets the search type to be used with the user basic collaborative search:
          "1" - Match case, beginning with
          "2" - Match case, containing
          "3" - Ignore case, beginning with
          "4" - Ignore case, containing
          "5" - Match case, exact match
          "6" - Ignore case, exact match
          "7" - Ignore case, ends with
          "8" - Match case, ends with
        If unspecified, the default search criteria is "4".
        Parameters:
        astrSearchType - The search type used when finding users.
      • setBasicCollaborativeSearch

        public void setBasicCollaborativeSearch(boolean bSearch)
        Sets the basic collaborative search. A basic collaborative search uses the "OR" operator on all the provided fields. The number of fields can vary depending on whether the value is provided. The valid field names are: logonId, first name, last name, city, email, phone, and zip code.
        Parameters:
        bSearch - the flag to indicate if the search is a basic collaborative search. true: basic collaborative search, false: otherwise.
      • setMobilePhone

        public void setMobilePhone(java.lang.String newMobilePhone)
        Sets the mobile phone number of the user to search.
        Parameters:
        newMobilePhone - the mobile number of the user.
      • getMobilePhone

        public java.lang.String getMobilePhone()
        Gets the mobile phone number of the user.
        Returns:
        The mobile phone of the user.