com.ibm.commerce.user.beans

Class UserListDataBean

java.lang.Object

com.ibm.commerce.beans.InputDataBeanImpl

com.ibm.commerce.beans.SmartDataBeanImpl

com.ibm.commerce.user.beans.UserListDataBeanBase

com.ibm.commerce.user.beans.UserListDataBean

All Implemented Interfaces:

DataBean, InputDataBean, SmartDataBean, Delegator, Protectable, java.io.Serializable

public class UserListDataBean
extends UserListDataBeanBase

The bean is used to search for users based on different search criteria.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	COPYRIGHT Copyright.

Fields inherited from interface com.ibm.commerce.beans.DataBean

emptyString

Constructor Summary

Constructors

Constructor and Description
UserListDataBean() Null argument constructor.

Method Summary

Modifier and Type	Method and Description
java.util.Vector	getUserIds() Gets a vector of the user IDs
int	getUserLength() Gets length of the search results.
java.util.Vector	getUserNames() Gets a vector of the user names
void	populate() Populates the data bean.
void	setMaxResults(int anMaxResults) Set the value for the maximum number of results to return.
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().

Methods inherited from class com.ibm.commerce.user.beans.UserListDataBeanBase

getDelegate, getOwner

Methods inherited from class com.ibm.commerce.beans.SmartDataBeanImpl

fulfills, getCommandContext, getHttpRequest, getHttpResponse, getResources, getViewCommandContext, setCommandContext, setHttpRequest, setHttpResponse, setViewCommandContext

Methods inherited from class com.ibm.commerce.beans.InputDataBeanImpl

getRequestProperties, setRequestProperties

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.ibm.commerce.security.Protectable

fulfills

Methods inherited from interface com.ibm.commerce.beans.InputDataBean

getRequestProperties, setRequestProperties

Field Detail

COPYRIGHT

public static final java.lang.String COPYRIGHT

Copyright.

See Also:

Constant Field Values

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.