com.ibm.commerce.user.beans

Class UserListDataBean

    • Field Detail

    • Constructor Detail

      • UserListDataBean

        public UserListDataBean()
        Null argument constructor.
    • Method Detail

      • setSearchCriteria

        public void setSearchCriteria(java.lang.Long adminId,
                                      java.lang.String userName,
                                      java.lang.String searchType,
                                      java.lang.String returningUserCriteria)
        To specify the search criteria option before invoking the method populate(). Please see the following details for proper usage.
        Parameters:
        adminId - the ID of the administrator
        userName - the search string which will be used to search on the logon ID of the users
        searchType - specify the search criteria option, the valid options:
        • 0 - No criteria: search for all eligible users that the current logged in user is allowed to manage.
        • 1 - Match case, begins with.
        • 2 - Match case, contains.
        • 3 - Ignore case, begins with.
        • 4 - Ignore case, contains.
        • 5 - Match case, exact match.
        returningUserCriteria - specify the kind of users that need to be returned.
        • 1 - For returning only users who are registered customers
        • 2 - For returning only users who are CSR/CSS/Seller
        • 3 - For returning any administrator users
      • setMaxResults

        public void setMaxResults(int anMaxResults)
        Set the value for the maximum number of results to return.
        Parameters:
        anMaxResults - The value for the maximum number of results to return.
      • populate

        public void populate()
                      throws java.lang.Exception
        Populates the data bean. If setMaxResults(int) was called, then only up to the maximum number of specified users will be returned.
        Specified by:
        populate in interface SmartDataBean
        Overrides:
        populate in class SmartDataBeanImpl
        Throws:
        java.lang.Exception - Thrown when UserAccessBean cannot retrieve the data according to search criteria.
      • getUserLength

        public int getUserLength()
        Gets length of the search results.
        Returns:
        the length of the search results.
      • getUserIds

        public java.util.Vector getUserIds()
        Gets a vector of the user IDs
        Returns:
        the vector of user IDs.
      • getUserNames

        public java.util.Vector getUserNames()
        Gets a vector of the user names
        Returns:
        the vector of user names.