com.ibm.commerce.user.beans

Class CustomerSearchDataBeanBase

java.lang.Object

com.ibm.commerce.user.beans.CustomerSearchDataBeanBase

Direct Known Subclasses:

CustomerSearchDataBean

public class CustomerSearchDataBeanBase
extends java.lang.Object

Provides user search capability to the administrative tools. The methods are designed to search the users based on the criteria specified. There is no access control on the methods of this bean, because the keys returned should be resolved using the corresponding protected databean. For example, if a list of users are returned, a new UserDataBean should be instantiated using the DataBeanManager for each user identifier to \ ensure that appropriate access control checks are performed.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CLASSNAME The class name.
static java.lang.String	COPYRIGHT IBM Copyright

Constructor Summary

Constructors

Constructor and Description
CustomerSearchDataBeanBase()

Method Summary

Modifier and Type	Method and Description
java.util.Vector	findCSRAdmins(WhereClauseCondition aWhereClauseCondition, java.lang.String astrOrderByTableName, java.lang.String astrOrderByFieldName, java.lang.String astrStartIndex, java.lang.String astrMaxResults) General purpose method for finding Customer Service Representative users with an Administrator role.
java.util.Vector	findCSRAdmins(WhereClauseCondition aWhereClauseCondition, java.lang.String astrOrderByTableName, java.lang.String astrOrderByFieldName, java.lang.String astrStartIndex, java.lang.String astrMaxResults, WhereClauseCondition accessFilterWhereClause) General purpose method for finding Customer Service Representative users with an Administrator role.
java.util.Vector	findOrganizationsICanAdminister(java.lang.String astrTaskName, java.lang.String astrOrgName, java.lang.String astrOrgNameSearchType, java.lang.String astrParentOrgName, java.lang.String astrParentOrgNameSearchType, java.lang.String astrStartIndex, java.lang.String astrMaxResults) Gets a list of organizations on which the current user is allowed to perform specified administrative tasks.
java.util.Vector	findOrganizationsWhereRoleIsPlayed(java.lang.String astrOrgName, java.lang.String astrOrgNameSearchType, java.lang.String astrStartIndex, java.lang.String astrMaxResults) Gets a list of organizations where the user plays any role, except Registered Customer role.
java.util.Vector	findOrganizationsWhereRoleIsPlayedExcludingAD(java.lang.String astrOrgName, java.lang.String astrOrgNameSearchType, java.lang.String astrStartIndex, java.lang.String astrMaxResults) Gets a list of organizations where the user plays any role, except Registered Customer role.
java.util.Vector	findRegisteredCustomers(WhereClauseCondition aWhereClauseCondition, java.lang.String astrOrderByTableName, java.lang.String astrOrderByFieldName, java.lang.String astrStartIndex, java.lang.String astrMaxResults) General purpose method for finding Registered Customers.
java.util.Vector	findRegisteredCustomers(WhereClauseCondition aWhereClauseCondition, java.lang.String astrOrderByTableName, java.lang.String astrOrderByFieldName, java.lang.String astrStartIndex, java.lang.String astrMaxResults, java.util.List storeIds) General purpose method for finding Registered Customers.
java.util.Vector	findRegisteredCustomers(WhereClauseCondition aWhereClauseCondition, java.lang.String astrOrderByTableName, java.lang.String astrOrderByFieldName, java.lang.String astrStartIndex, java.lang.String astrMaxResults, WhereClauseCondition accessFilterWhereClause) General purpose method for finding Registered Customers.
java.util.Vector	findRegisteredCustomerStores(WhereClauseCondition aWhereClauseCondition, java.lang.Long aUserId, java.lang.String astrOrderByTableName, java.lang.String astrOrderByFieldName, java.lang.String astrStartIndex, java.lang.String astrMaxResults) General purpose method for finding Store IDs for a registered customer.
java.util.Vector	findUsersInOrganizationsICanAdminister(java.lang.String astrLogonId, java.lang.String astrLogonIdSearchType, java.lang.String astrFirstName, java.lang.String astrFirstNameSearchType, java.lang.String astrLastName, java.lang.String astrLastNameSearchType, java.lang.String astrParentOrgName, java.lang.String astrParentOrgNameSearchType, java.lang.String astrRoleId, java.lang.String astrOrderByTableName, java.lang.String astrOrderByFieldName, java.lang.String astrStartIndex, java.lang.String astrMaxResults) Finds business users and administrators by at least one of the following search criteria: user’s logonId,, first name, last name, role played, parent organization name.
java.util.Vector	findUsersInOrganizationsICanAdminister(java.lang.String astrLogonId, java.lang.String astrLogonIdSearchType, java.lang.String astrFirstName, java.lang.String astrFirstNameSearchType, java.lang.String astrLastName, java.lang.String astrLastNameSearchType, java.lang.String astrParentOrgName, java.lang.String astrParentOrgNameSearchType, java.lang.String astrRoleId, java.lang.String astrAccountStatus, java.lang.String astrParentOrgId, java.lang.String astrOrderByTableName, java.lang.String astrOrderByFieldName, java.lang.String astrStartIndex, java.lang.String astrMaxResults) Finds business users and administrators by at least one of the following search criteria: user’s logonId,, first name, last name, parent organization name, role played, account status, parent organization Id.
java.util.Vector	findUsersInOrganizationsICanAdminister(java.lang.String astrLogonId, java.lang.String astrLogonIdSearchType, java.lang.String astrFirstName, java.lang.String astrFirstNameSearchType, java.lang.String astrLastName, java.lang.String astrLastNameSearchType, java.lang.String astrParentOrgName, java.lang.String astrParentOrgNameSearchType, java.lang.String astrRoleId, java.lang.String astrAccountStatus, java.lang.String astrParentOrgId, WhereClauseCondition customWhereClause, java.lang.String astrOrderByTableName, java.lang.String astrOrderByFieldName, java.lang.String astrStartIndex, java.lang.String astrMaxResults) Finds business users and administrators by at least one of the following search criteria: user’s logonId,, first name, last name, parent organization name, role played, account status, parent organization Id.
java.util.Vector	findWorkspaceUsers(java.lang.String astrLogonId, java.lang.String astrLogonIdSearchType, java.lang.String astrFirstName, java.lang.String astrFirstNameSearchType, java.lang.String astrLastName, java.lang.String astrLastNameSearchType, java.util.Vector avctTargetRoleIds, java.util.Vector avctRequesterRoleIds, java.lang.String astrOrderByTableName, java.lang.String astrOrderByFieldName, java.lang.String astrStartIndex, java.lang.String astrMaxResults) Finds business users and administrators by at least one of the following search criteria: user’s logonId,, first name, last name, and with a specific role played.
CommandContext	getCommandContext() Gets the command context.
java.lang.Integer	getResultSize() Gets the count of all elements retured by this search.
boolean	getRetrieveCountOnly() Returns the retrieveCountOnly flag.
void	setCommandContext(CommandContext aCommandContext) Sets the command context.
void	setRetrieveCountOnly(boolean abRetrieveCountOnly) Set whether or not to retrieve the count only.

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

See Also:

Constant Field Values

CLASSNAME

public static final java.lang.String CLASSNAME

The class name.

Constructor Detail

CustomerSearchDataBeanBase

public CustomerSearchDataBeanBase()

Method Detail

setCommandContext

public void setCommandContext(CommandContext aCommandContext)

Sets the command context. This method should be invoked before invoking search methods.

Parameters:

aCommandContext - The command context.

getCommandContext

public CommandContext getCommandContext()

Gets the command context.

Returns:

The command context.

getResultSize

public java.lang.Integer getResultSize()

Gets the count of all elements retured by this search.

Returns:

The result size

findUsersInOrganizationsICanAdminister

public java.util.Vector findUsersInOrganizationsICanAdminister(java.lang.String astrLogonId,
                                                               java.lang.String astrLogonIdSearchType,
                                                               java.lang.String astrFirstName,
                                                               java.lang.String astrFirstNameSearchType,
                                                               java.lang.String astrLastName,
                                                               java.lang.String astrLastNameSearchType,
                                                               java.lang.String astrParentOrgName,
                                                               java.lang.String astrParentOrgNameSearchType,
                                                               java.lang.String astrRoleId,
                                                               java.lang.String astrOrderByTableName,
                                                               java.lang.String astrOrderByFieldName,
                                                               java.lang.String astrStartIndex,
                                                               java.lang.String astrMaxResults)

Finds business users and administrators by at least one of the following search criteria: user’s logonId,, first name, last name, role played, parent organization name.

Parameters:

astrLogonId - The user's logonId.

astrLogonIdSearchType - The search type (valid values are defined as constants on the WhereClauseSearchConditions class).

astrFirstName - The user's first name.

astrFirstNameSearchType - The search type (valid values are defined as constants on the WhereClauseSearchConditions class).

astrLastName - The user's last name.

astrLastNameSearchType - The search type (valid values are defined as constants on the WhereClauseSearchConditions class).

astrParentOrgName - The user's parent organization name.

astrParentOrgNameSearchType - The parent organization name search type.

astrRoleId - The role Id to search by.

astrOrderByTableName - The table to order the results by.

astrOrderByFieldName - The field to order the results by.

astrStartIndex - The starting index.

astrMaxResults - The maximum number of results to return.

Returns:

Vector of Vector of users.

findUsersInOrganizationsICanAdminister

public java.util.Vector findUsersInOrganizationsICanAdminister(java.lang.String astrLogonId,
                                                               java.lang.String astrLogonIdSearchType,
                                                               java.lang.String astrFirstName,
                                                               java.lang.String astrFirstNameSearchType,
                                                               java.lang.String astrLastName,
                                                               java.lang.String astrLastNameSearchType,
                                                               java.lang.String astrParentOrgName,
                                                               java.lang.String astrParentOrgNameSearchType,
                                                               java.lang.String astrRoleId,
                                                               java.lang.String astrAccountStatus,
                                                               java.lang.String astrParentOrgId,
                                                               java.lang.String astrOrderByTableName,
                                                               java.lang.String astrOrderByFieldName,
                                                               java.lang.String astrStartIndex,
                                                               java.lang.String astrMaxResults)

Finds business users and administrators by at least one of the following search criteria: user’s logonId,, first name, last name, parent organization name, role played, account status, parent organization Id.

Parameters:

astrLogonId - The user's logonId.

astrLogonIdSearchType - The search type (valid values are defined as constants on the WhereClauseSearchConditions class).

astrFirstName - The user's first name.

astrFirstNameSearchType - The search type (valid values are defined as constants on the WhereClauseSearchConditions class).

astrLastName - The user's last name.

astrLastNameSearchType - The search type (valid values are defined as constants on the WhereClauseSearchConditions class).

astrParentOrgName - The user's parent organization name.

astrParentOrgNameSearchType - The parent organization name search type.

astrRoleId - The role Id to search by.

astrAccountStatus - The user's account status to search by.

astrParentOrgId - The Id of user's parent organization to search by.

astrOrderByTableName - The table to order the results by.

astrOrderByFieldName - The field to order the results by.

astrStartIndex - The starting index.

astrMaxResults - The maximum number of results to return.

Returns:

Vector of Vector of users.

findUsersInOrganizationsICanAdminister

public java.util.Vector findUsersInOrganizationsICanAdminister(java.lang.String astrLogonId,
                                                               java.lang.String astrLogonIdSearchType,
                                                               java.lang.String astrFirstName,
                                                               java.lang.String astrFirstNameSearchType,
                                                               java.lang.String astrLastName,
                                                               java.lang.String astrLastNameSearchType,
                                                               java.lang.String astrParentOrgName,
                                                               java.lang.String astrParentOrgNameSearchType,
                                                               java.lang.String astrRoleId,
                                                               java.lang.String astrAccountStatus,
                                                               java.lang.String astrParentOrgId,
                                                               WhereClauseCondition customWhereClause,
                                                               java.lang.String astrOrderByTableName,
                                                               java.lang.String astrOrderByFieldName,
                                                               java.lang.String astrStartIndex,
                                                               java.lang.String astrMaxResults)

Finds business users and administrators by at least one of the following search criteria: user’s logonId,, first name, last name, parent organization name, role played, account status, parent organization Id.

Parameters:

astrLogonId - The user's logonId.

astrLogonIdSearchType - The search type (valid values are defined as constants on the WhereClauseSearchConditions class).

astrFirstName - The user's first name.

astrFirstNameSearchType - The search type (valid values are defined as constants on the WhereClauseSearchConditions class).

astrLastName - The user's last name.

astrLastNameSearchType - The search type (valid values are defined as constants on the WhereClauseSearchConditions class).

astrParentOrgName - The user's parent organization name.

astrParentOrgNameSearchType - The parent organization name search type.

astrRoleId - The role Id to search by.

astrAccountStatus - The user's account status to search by.

astrParentOrgId - The Id of user's parent organization to search by.

customWhereClause - Custom WhereClause condition which will be used in the final query.

astrOrderByTableName - The table to order the results by.

astrOrderByFieldName - The field to order the results by.

astrStartIndex - The starting index.

astrMaxResults - The maximum number of results to return.

Returns:

Vector of Vector of users.

findRegisteredCustomers

public java.util.Vector findRegisteredCustomers(WhereClauseCondition aWhereClauseCondition,
                                                java.lang.String astrOrderByTableName,
                                                java.lang.String astrOrderByFieldName,
                                                java.lang.String astrStartIndex,
                                                java.lang.String astrMaxResults)

General purpose method for finding Registered Customers. Will retrieve all shoppers with Registered Customer role in the specified store. Access control pre-filtering will ensure that only users who play the Regustered Custoner role under the organization where the currently active user plays an administrative role will be returned. For this reason, the Command Context must be set before invoking this method.

Parameters:

aWhereClauseCondition - The where clause conditions.

astrOrderByTableName - The table to order the results by.

astrOrderByFieldName - The field to order the results by.

astrStartIndex - The starting index.

astrMaxResults - The maximum number of results to return.

Returns:

Vector of Vector of users.

findRegisteredCustomers

public java.util.Vector findRegisteredCustomers(WhereClauseCondition aWhereClauseCondition,
                                                java.lang.String astrOrderByTableName,
                                                java.lang.String astrOrderByFieldName,
                                                java.lang.String astrStartIndex,
                                                java.lang.String astrMaxResults,
                                                java.util.List storeIds)

General purpose method for finding Registered Customers. Will retrieve all shoppers with a Registered Customer role in the specified stores. Access control pre-filtering will ensure that only users who match the access filter where clause are returned.

Parameters:

aWhereClauseCondition - The where clause conditions.

astrOrderByTableName - The table to order the results by.

astrOrderByFieldName - The field to order the results by.

astrStartIndex - The starting index.

astrMaxResults - The maximum number of results to return.

storeIds - A list of store Ids

Returns:

Vector of Vector of users.

findRegisteredCustomers

public java.util.Vector findRegisteredCustomers(WhereClauseCondition aWhereClauseCondition,
                                                java.lang.String astrOrderByTableName,
                                                java.lang.String astrOrderByFieldName,
                                                java.lang.String astrStartIndex,
                                                java.lang.String astrMaxResults,
                                                WhereClauseCondition accessFilterWhereClause)

General purpose method for finding Registered Customers. Will retrieve all shoppers with a registered customer role in the specified stores. Access control prefiltering will ensure that only users who match the access filter where clause will be returned.

Parameters:

aWhereClauseCondition - The where clause conditions.

astrOrderByTableName - The table to order the results by.

astrOrderByFieldName - The field to order the results by.

astrStartIndex - The starting index.

astrMaxResults - The maximum number of results to return.

accessFilterWhereClause - Access filter where clause

Returns:

Vector of Vector of users.

findRegisteredCustomerStores

public java.util.Vector findRegisteredCustomerStores(WhereClauseCondition aWhereClauseCondition,
                                                     java.lang.Long aUserId,
                                                     java.lang.String astrOrderByTableName,
                                                     java.lang.String astrOrderByFieldName,
                                                     java.lang.String astrStartIndex,
                                                     java.lang.String astrMaxResults)

General purpose method for finding Store IDs for a registered customer. Will retrieve all stores where the specified registered customer has a Registered Customer role. Access control pre-filtering will ensure that only stores who match the access filter where clause will be returned.

Parameters:

aWhereClauseCondition - The where clause conditions.

aUserId - Customer user ID

astrOrderByTableName - The table to order the results by.

astrOrderByFieldName - The field to order the results by.

astrStartIndex - The starting index.

astrMaxResults - The maximum number of results to return.

Returns:

Vector of Vector of stores.

findOrganizationsWhereRoleIsPlayedExcludingAD

public java.util.Vector findOrganizationsWhereRoleIsPlayedExcludingAD(java.lang.String astrOrgName,
                                                                      java.lang.String astrOrgNameSearchType,
                                                                      java.lang.String astrStartIndex,
                                                                      java.lang.String astrMaxResults)

Gets a list of organizations where the user plays any role, except Registered Customer role. It includes organizations that are part of the Registered Customers member group that is owned by an organization where the user plays one of the following roles: Seller Administrator, Customer Service Representative or Customer Service Supervisor. It does not include Authorization Domain organizations.

Parameters:

astrOrgName -

astrOrgNameSearchType -

astrStartIndex -

astrMaxResults -

Returns:

Vector of Vectors; outer Vector represents the resultset, inner Vectors have the organization Id in position 0, and the organization name in position 1

findOrganizationsWhereRoleIsPlayed

public java.util.Vector findOrganizationsWhereRoleIsPlayed(java.lang.String astrOrgName,
                                                           java.lang.String astrOrgNameSearchType,
                                                           java.lang.String astrStartIndex,
                                                           java.lang.String astrMaxResults)

Gets a list of organizations where the user plays any role, except Registered Customer role. It includes organizations that are part of the Registered Customers member group that is owned by an organization where the user plays one of the following roles: Seller Administrator, Customer Service Representative or Customer Service Supervisor.

Parameters:

astrOrgName -

astrOrgNameSearchType -

astrStartIndex -

astrMaxResults -

Returns:

Vector of Vectors; outer Vector represents the resultset, inner Vectors have the organization Id in position 0, and the organization name in position 1

findOrganizationsICanAdminister

public java.util.Vector findOrganizationsICanAdminister(java.lang.String astrTaskName,
                                                        java.lang.String astrOrgName,
                                                        java.lang.String astrOrgNameSearchType,
                                                        java.lang.String astrParentOrgName,
                                                        java.lang.String astrParentOrgNameSearchType,
                                                        java.lang.String astrStartIndex,
                                                        java.lang.String astrMaxResults)

Gets a list of organizations on which the current user is allowed to perform specified administrative tasks.

Parameters:

astrTaskName - One of the following task names "Manage" (default used by Organization Administration Console), "ManageExcludingAD", "ManageO" (default used by Store Publish), "ManageOU", "AssignRoleToUser". The tasks are as follows:

 Manage
 The list of organizational entities (OrgEntityType = "O" or "OU" or "AD") that the current user is allowed to manage 
 and perform administrative tasks such as updating the  profile. 
 These are the organizations where the user has one of the following administrative roles: Site Administrator,
 Seller Administrator, Buyer Administrator or Channel Manager.
 It also includes organizations that are part of the RegisteredCustomers 
 member group that is owned by an organization where the user plays one of the following roles: 
 Seller Administrator, Customer Service Representative or Customer Service Supervisor.

 ManageExcludingAD
 The list of organizations and organization units (OrgEntityType="O" or "OU")that the current user can manage (same as Manage task).  

 ManageO
 The list of organizations (OrgEntityType="O") that the current user can manage.
 
 ManageOU
 The list of organization units (OrgEntityType="OU") that the current user can manage.
 
 AssignRoleToUser
 The organizations for which the current user is allowed to assign roles to other users.
 This includes organizations where the current user has one of the following roles: Site Administrator,
 Seller Administrator, Buyer Administrator, Channel Manager, Customer Service Representative or 
 Customer Service Supervisor.  It also includes organizations that are part of the RegisteredCustomers member group that is owned by an organization 
 in which  the current user plays one of the following roles:  Seller Administrator, Customer Service Representative 
 or Customer Service Supervisor. The list includes Authorization Domain organizations.
 

astrOrgName -

astrOrgNameSearchType -

astrParentOrgName -

astrParentOrgNameSearchType -

astrStartIndex -

astrMaxResults -

Returns:

Vector of Vectors; outer Vector represents the Result Set; inner Vectors have the organization Id in position 0, and the organization name in position 1

findCSRAdmins

public java.util.Vector findCSRAdmins(WhereClauseCondition aWhereClauseCondition,
                                      java.lang.String astrOrderByTableName,
                                      java.lang.String astrOrderByFieldName,
                                      java.lang.String astrStartIndex,
                                      java.lang.String astrMaxResults)

General purpose method for finding Customer Service Representative users with an Administrator role. Access control pre-filtering will ensure that only users who play the administrator role under organization in which the currently active user plays an administrative role will be returned. For this reason, the Command Context must be set before invoking this method.

Parameters:

aWhereClauseCondition - The where clause conditions.

astrOrderByTableName - The table to order the results by.

astrOrderByFieldName - The field to order the results by.

astrStartIndex - The starting index.

astrMaxResults - The maximum number of results to return.

Returns:

Vector of Vector of users.

findCSRAdmins

public java.util.Vector findCSRAdmins(WhereClauseCondition aWhereClauseCondition,
                                      java.lang.String astrOrderByTableName,
                                      java.lang.String astrOrderByFieldName,
                                      java.lang.String astrStartIndex,
                                      java.lang.String astrMaxResults,
                                      WhereClauseCondition accessFilterWhereClause)

General purpose method for finding Customer Service Representative users with an Administrator role. Access control pre-filtering will ensure that only users who match the access filter where clause will be returned.

Parameters:

aWhereClauseCondition - The where clause conditions.

astrOrderByTableName - The table to order the results by.

astrOrderByFieldName - The field to order the results by.

astrStartIndex - The starting index.

astrMaxResults - The maximum number of results to return.

accessFilterWhereClause - Access filter where clause

Returns:

Vector of Vector of users.

findWorkspaceUsers

public java.util.Vector findWorkspaceUsers(java.lang.String astrLogonId,
                                           java.lang.String astrLogonIdSearchType,
                                           java.lang.String astrFirstName,
                                           java.lang.String astrFirstNameSearchType,
                                           java.lang.String astrLastName,
                                           java.lang.String astrLastNameSearchType,
                                           java.util.Vector avctTargetRoleIds,
                                           java.util.Vector avctRequesterRoleIds,
                                           java.lang.String astrOrderByTableName,
                                           java.lang.String astrOrderByFieldName,
                                           java.lang.String astrStartIndex,
                                           java.lang.String astrMaxResults)

Finds business users and administrators by at least one of the following search criteria: user’s logonId,, first name, last name, and with a specific role played.

Parameters:

astrLogonId - The user's logonId.

astrLogonIdSearchType - The search type (valid values are defined as constants on the WhereClauseSearchConditions class).

astrFirstName - The user's first name.

astrFirstNameSearchType - The search type (valid values are defined as constants on the WhereClauseSearchConditions class).

astrLastName - The user's last name.

astrLastNameSearchType - The search type (valid values are defined as constants on the WhereClauseSearchConditions class).

avctTargetRoleIds - Vector of role Id's to search by.

avctRequesterRoleIds - Vector of role Id's of requester.

astrOrderByTableName - The table to order the results by.

astrOrderByFieldName - The field to order the results by.

astrStartIndex - The starting index.

astrMaxResults - The maximum number of results to return.

Returns:

vecResults Vector of users.

setRetrieveCountOnly

public void setRetrieveCountOnly(boolean abRetrieveCountOnly)

Set whether or not to retrieve the count only.

Parameters:

abRetrieveCountOnly - true if the query should return the count only; false if it should return the full java.sql.ResultSet .

getRetrieveCountOnly

public boolean getRetrieveCountOnly()

Returns the retrieveCountOnly flag.

Returns:

- True if the query should return the count only; False if it should return the full java.sql.ResultSet .