Field Detail

• COPYRIGHT

  public static final java.lang.String COPYRIGHT
  

  IBM copyright notice field.

  See Also:

  Constant Field Values

Constructor Detail

• UserSearchBean

  public UserSearchBean()
  

Method Detail

• ejbActivate

  public void ejbActivate()
  

  ejbActivate method comment

  Specified by:

  ejbActivate in interface javax.ejb.SessionBean

• ejbCreate

  public void ejbCreate()
                 throws javax.ejb.CreateException
  

  ejbCreate method comment

  Throws:

  javax.ejb.CreateException - The exception description.

• ejbPassivate

  public void ejbPassivate()
  

  ejbPassivate method comment

  Specified by:

  ejbPassivate in interface javax.ejb.SessionBean

• ejbRemove

  public void ejbRemove()
  

  ejbRemove method comment

  Specified by:

  ejbRemove in interface javax.ejb.SessionBean

• findBusinessUsers

  public com.ibm.commerce.tools.optools.common.helpers.DynamicListData findBusinessUsers(java.lang.String lastName,
                                                                                java.lang.String orgId,
                                                                                java.lang.String roleId,
                                                                                java.lang.String orderby,
                                                                                java.lang.Integer start,
                                                                                java.lang.Integer maxLength)
                                                                                  throws javax.naming.NamingException,
                                                                                         java.sql.SQLException,
                                                                                         javax.ejb.CreateException
  

  Deprecated. Functionality replaced by findUsersInOrgsICanAdmin() from class CustomerSearchDataBean.
  Find registered business users.

  Parameters:

  lastName - java.lang.String

  orgId - java.lang.String

  roleId - java.lang.String

  orderby - java.lang.String

  start - java.lang.Integer

  maxLength - java.lang.Integer

  Returns:

  java.util.Vector

  Throws:

  javax.naming.NamingException

  java.sql.SQLException

  javax.ejb.CreateException

• findBusinessUsers

  public com.ibm.commerce.tools.optools.common.helpers.DynamicListData findBusinessUsers(java.lang.String lastName,
                                                                                java.lang.String orgId,
                                                                                java.lang.String roleId,
                                                                                java.lang.String orderby,
                                                                                java.lang.Integer start,
                                                                                java.lang.Integer maxLength,
                                                                                java.lang.String strActiveUserId)
                                                                                  throws javax.naming.NamingException,
                                                                                         java.sql.SQLException,
                                                                                         javax.ejb.CreateException
  

  Deprecated. Functionality replaced by findUsersInOrgsICanAdmin() from class CustomerSearchDataBean.
  Find registered business users.

  Parameters:

  lastName - java.lang.String

  orgId - java.lang.String

  roleId - java.lang.String

  orderby - java.lang.String

  start - java.lang.Integer

  maxLength - java.lang.Integer

  strActiveUserId - java.lang.String

  Returns:

  java.util.Vector

  Throws:

  javax.naming.NamingException

  java.sql.SQLException

  javax.ejb.CreateException

• findCollaborativeMembers

  public com.ibm.commerce.tools.optools.common.helpers.DynamicListData findCollaborativeMembers(java.lang.String logonId,
                                                                                       java.lang.String firstName,
                                                                                       java.lang.String lastName,
                                                                                       java.lang.String phone,
                                                                                       java.lang.String email,
                                                                                       java.lang.String city,
                                                                                       java.lang.String zip,
                                                                                       java.lang.String accountId,
                                                                                       java.lang.String orderby,
                                                                                       java.lang.String storeType,
                                                                                       java.lang.String storeMemberId,
                                                                                       java.lang.Integer start,
                                                                                       java.lang.Integer maxLength)
                                                                                         throws javax.naming.NamingException,
                                                                                                java.sql.SQLException,
                                                                                                javax.ejb.CreateException
  

  Deprecated. This method is replaced by findCollaborativeMembers(String, String, String, String, String, String, String, String, String, String, String, Integer, Integer, String)
  Search for Collaborative Users - Registered Users and Administrators - if an account is specified, anyone under the account

  Parameters:

  logonId - java.lang.String

  firstName - java.lang.String

  lastName - java.lang.String

  phone - java.lang.String

  email - java.lang.String

  city - java.lang.String

  zip - java.lang.String

  accountId - java.lang.String

  orderby - java.lang.String

  storeType - java.lang.String

  storeMemberId - java.lang.String

  start - java.lang.Integer

  maxLength - java.lang.Integer

  Returns:

  java.util.Vector

  Throws:

  javax.naming.NamingException

  java.sql.SQLException

  javax.ejb.CreateException

• findCollaborativeMembers

  public com.ibm.commerce.tools.optools.common.helpers.DynamicListData findCollaborativeMembers(java.lang.String logonId,
                                                                                       java.lang.String firstName,
                                                                                       java.lang.String lastName,
                                                                                       java.lang.String phone,
                                                                                       java.lang.String email,
                                                                                       java.lang.String city,
                                                                                       java.lang.String zip,
                                                                                       java.lang.String accountId,
                                                                                       java.lang.String orderby,
                                                                                       java.lang.String storeType,
                                                                                       java.lang.String storeMemberId,
                                                                                       java.lang.Integer start,
                                                                                       java.lang.Integer maxLength,
                                                                                       java.lang.String strActiveUserId)
                                                                                         throws javax.naming.NamingException,
                                                                                                java.sql.SQLException,
                                                                                                javax.ejb.CreateException
  

  Search for Collaborative Users - Registered Users and Administrators - if an account is specified, anyone under the account

  Parameters:

  logonId - java.lang.String

  firstName - java.lang.String

  lastName - java.lang.String

  phone - java.lang.String

  email - java.lang.String

  city - java.lang.String

  zip - java.lang.String

  accountId - java.lang.String

  orderby - java.lang.String

  storeType - java.lang.String

  storeMemberId - java.lang.String

  start - java.lang.Integer

  maxLength - java.lang.Integer

  strActiveUserId - java.lang.String

  Returns:

  java.util.Vector

  Throws:

  javax.naming.NamingException

  java.sql.SQLException

  javax.ejb.CreateException

• findCustomers

  public com.ibm.commerce.tools.optools.common.helpers.DynamicListData findCustomers(java.lang.String logonId,
                                                                            java.lang.String firstName,
                                                                            java.lang.String lastName,
                                                                            java.lang.String phone,
                                                                            java.lang.String email,
                                                                            java.lang.String city,
                                                                            java.lang.String zip,
                                                                            java.lang.String accountId,
                                                                            java.lang.String orderby,
                                                                            java.lang.String storeType,
                                                                            java.lang.String storeMemberId,
                                                                            java.lang.Integer start,
                                                                            java.lang.Integer maxLength)
                                                                              throws javax.naming.NamingException,
                                                                                     java.sql.SQLException
  

  Deprecated. This method is replaced by findCustomers(String, String, String, String, String, String, String, String, String, String, String, Integer, Integer, String)
  Search for customers registered to a store.

  Parameters:

  logonId - java.lang.String

  firstName - java.lang.String

  lastName - java.lang.String

  phone - java.lang.String

  email - java.lang.String

  city - java.lang.String

  zip - java.lang.String

  accountId - java.lang.String

  orderby - java.lang.String

  storeType - java.lang.String

  storeMemberId - java.lang.String

  start - java.lang.Integer

  maxLength - java.lang.Integer

  Returns:

  customers registerd to a store.

  Throws:

  javax.naming.NamingException

  java.sql.SQLException

• findCustomers

  public com.ibm.commerce.tools.optools.common.helpers.DynamicListData findCustomers(java.lang.String logonId,
                                                                            java.lang.String firstName,
                                                                            java.lang.String lastName,
                                                                            java.lang.String phone,
                                                                            java.lang.String email,
                                                                            java.lang.String city,
                                                                            java.lang.String zip,
                                                                            java.lang.String accountId,
                                                                            java.lang.String orderby,
                                                                            java.lang.String storeType,
                                                                            java.lang.String storeMemberId,
                                                                            java.lang.Integer start,
                                                                            java.lang.Integer maxLength,
                                                                            java.lang.String strActiveUserId)
                                                                              throws javax.naming.NamingException,
                                                                                     java.sql.SQLException
  

  Search for customers registered to a store.

  Parameters:

  logonId - java.lang.String

  firstName - java.lang.String

  lastName - java.lang.String

  phone - java.lang.String

  email - java.lang.String

  city - java.lang.String

  zip - java.lang.String

  accountId - java.lang.String

  orderby - java.lang.String

  storeType - java.lang.String

  storeMemberId - java.lang.String

  start - java.lang.Integer

  maxLength - java.lang.Integer

  strActiveUserId - java.lang.String

  Returns:

  customers registerd to a store.

  Throws:

  javax.naming.NamingException

  java.sql.SQLException

• findCustomersAdvancedSearch

  public com.ibm.commerce.tools.optools.common.helpers.DynamicListData findCustomersAdvancedSearch(java.lang.String logonId,
                                                                                          java.lang.String logonIdSearchType,
                                                                                          java.lang.String firstName,
                                                                                          java.lang.String firstNameSearchType,
                                                                                          java.lang.String lastName,
                                                                                          java.lang.String lastNameSearchType,
                                                                                          java.lang.String phone,
                                                                                          java.lang.String phoneSearchType,
                                                                                          java.lang.String email,
                                                                                          java.lang.String emailSearchType,
                                                                                          java.lang.String city,
                                                                                          java.lang.String citySearchType,
                                                                                          java.lang.String zip,
                                                                                          java.lang.String zipSearchType,
                                                                                          java.lang.String accountId,
                                                                                          java.lang.String orderBy,
                                                                                          java.lang.String storeType,
                                                                                          java.lang.String storeMemberId,
                                                                                          java.lang.Integer start,
                                                                                          java.lang.Integer maxLength)
                                                                                            throws javax.naming.NamingException,
                                                                                                   java.sql.SQLException
  

  Deprecated. This method is replaced by findCustomersAdvancedSearch(String, String, String, String, String, String, String, String, String, String, String, String, String, String, String, String, String, String, Integer, Integer, String)
  Finds customers using advanced search. For each search fields, user can choose one of the following search type:

  • Match case, beginning with
  • Match case, containing
  • Ignore case, beginning with
  • Ignore case, containing
  • Exact Match
  • The search will be based on the search criteria. Some may have performance impact.

  Parameters:

  logonId - The customer's logon ID.

  logonIdSearchType - logonId field search type.

  firstName - The customer's firstName.

  firstNameSearchType - firstName search type.

  lastName - The customer's last name.

  lastNameSearchType - lastName search type.

  phone - The customer's phone number.

  phoneSearchType - phone search type.

  email - The customer's email address.

  emailSearchType - email search type.

  city - The city where the customer lives in.

  citySearchType - city search type.

  zip - The customer's address zip code.

  zipSearchType - zip search type.

  accountId - The customer's account ID.

  orderBy - The field name to be sorted.

  storeType - The store type.

  storeMemberId - The store member ID.

  start - Start index.

  maxLength - The max length for result return.

  Returns:

  com.ibm.commerce.tools.optools.common.helpers.DynamicListData

  Throws:

  javax.naming.NamingException - The exception description.

  java.sql.SQLException - The exception description.

• findCustomersAdvancedSearch

  public com.ibm.commerce.tools.optools.common.helpers.DynamicListData findCustomersAdvancedSearch(java.lang.String logonId,
                                                                                          java.lang.String logonIdSearchType,
                                                                                          java.lang.String firstName,
                                                                                          java.lang.String firstNameSearchType,
                                                                                          java.lang.String lastName,
                                                                                          java.lang.String lastNameSearchType,
                                                                                          java.lang.String phone,
                                                                                          java.lang.String phoneSearchType,
                                                                                          java.lang.String email,
                                                                                          java.lang.String emailSearchType,
                                                                                          java.lang.String city,
                                                                                          java.lang.String citySearchType,
                                                                                          java.lang.String zip,
                                                                                          java.lang.String zipSearchType,
                                                                                          java.lang.String accountId,
                                                                                          java.lang.String orderBy,
                                                                                          java.lang.String storeType,
                                                                                          java.lang.String storeMemberId,
                                                                                          java.lang.Integer start,
                                                                                          java.lang.Integer maxLength,
                                                                                          java.lang.String strActiveUserId)
                                                                                            throws javax.naming.NamingException,
                                                                                                   java.sql.SQLException
  

  Finds customers using advanced search. For each search fields, user can choose one of the following search type:

  • Match case, beginning with
  • Match case, containing
  • Ignore case, beginning with
  • Ignore case, containing
  • Exact Match
  • The search will be based on the search criteria. Some may have performance impact.

  Parameters:

  logonId - The customer's logon ID.

  logonIdSearchType - logonId field search type.

  firstName - The customer's firstName.

  firstNameSearchType - firstName search type.

  lastName - The customer's last name.

  lastNameSearchType - lastName search type.

  phone - The customer's phone number.

  phoneSearchType - phone search type.

  email - The customer's email address.

  emailSearchType - email search type.

  city - The city where the customer lives in.

  citySearchType - city search type.

  zip - The customer's address zip code.

  zipSearchType - zip search type.

  accountId - The customer's account ID.

  orderBy - The field name to be sorted.

  storeType - The store type.

  storeMemberId - The store member ID.

  start - Start index.

  maxLength - The max length for result return.

  strActiveUserId - java.lang.String

  Returns:

  com.ibm.commerce.tools.optools.common.helpers.DynamicListData

  Throws:

  javax.naming.NamingException - The exception description.

  java.sql.SQLException - The exception description.

• findCollaborativeMembersBasicSearch

  public com.ibm.commerce.tools.optools.common.helpers.DynamicListData findCollaborativeMembersBasicSearch(java.lang.String logonId,
                                                                                                  java.lang.String firstName,
                                                                                                  java.lang.String lastName,
                                                                                                  java.lang.String phone,
                                                                                                  java.lang.String mobilePhone,
                                                                                                  java.lang.String email,
                                                                                                  java.lang.String city,
                                                                                                  java.lang.String zip,
                                                                                                  java.lang.String orderby,
                                                                                                  java.lang.String storeMemberId,
                                                                                                  java.lang.Integer start,
                                                                                                  java.lang.Integer maxLength,
                                                                                                  boolean isLdapMode,
                                                                                                  java.lang.String rdnName,
                                                                                                  java.lang.String searchType)
                                                                                                    throws javax.naming.NamingException,
                                                                                                           java.sql.SQLException,
                                                                                                           javax.ejb.CreateException
  

  Search for Collaborative Users - Registered Users by default. - Registered Users and Administrators if the flag for this option is present in configuration file for purpose of backward compatibility. The basic collaborative member 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:

  logonId - java.lang.String the logon ID.

  firstName - java.lang.String the first name.

  lastName - java.lang.String the last name.

  phone - java.lang.String the phone number. this will be used to search the phone1 field in address table.

  mobilePhone - java.lang.String the mobile phone number. this will be used to search the mobilephone1 field in address table.

  email - java.lang.String the email. this will be used to search the email1 field in the address table

  city - java.lang.String the city name.

  zip - java.lang.String the zip code

  orderby - java.lang.String the order by collumn name.

  storeMemberId - java.lang.String the store owner Id.

  start - java.lang.Integer the start index.

  maxLength - java.lang.Integer the page size. If te value is -1, no paging.

  isLdapMode - if commerce member system using LDAP

  rdnName - the RDN attribute name of the LDAP server (uid or cn).

  searchType - the search type.

  Returns:

  java.util.Vector

  Throws:

  javax.naming.NamingException

  java.sql.SQLException

  javax.ejb.CreateException

• getSessionContext

  public javax.ejb.SessionContext getSessionContext()
  

  getSessionContext method comment

  Specified by:

  getSessionContext in class BaseJDBCHelper

  Returns:

  javax.ejb.SessionContext

• getUpperCaseFunction

  public static final java.lang.String getUpperCaseFunction()
  

  Gets the uppercase function for the configured the database.

  Returns:

  java.lang.String The uppercase function

• getLowerCaseFunction

  protected static final java.lang.String getLowerCaseFunction()
  

  Gets the lower case function SQL string for the database used.

  Returns:

  "LCASE" if uses DB2 or "LOWER" if uses Oracle. Default to DB2.

• setSessionContext

  public void setSessionContext(javax.ejb.SessionContext ctx)
                         throws java.rmi.RemoteException
  

  setSessionContext method comment

  Specified by:

  setSessionContext in interface javax.ejb.SessionBean

  Parameters:

  ctx - javax.ejb.SessionContext

  Throws:

  java.rmi.RemoteException - The exception description.

• executeCustomizeableMemberSearch

  public java.util.Vector executeCustomizeableMemberSearch(ECQuery aQuery)
                                                    throws javax.naming.NamingException,
                                                           java.sql.SQLException
  

  Used to execute a customizeable member search. This method is used by, among other classes, the CustomerSearchDataBean.

  Parameters:

  aQuery - The ECQuery object.

  Returns:

  Vector of Vectors. Each entry in the outer Vector is a row from java.sql.ResultSet, each entry in the inner Vector is a field from the SELECT clause.

  Throws:

  javax.naming.NamingException

  java.sql.SQLException