com.ibm.commerce.tools.optools.returns.beans

Class ReturnSearchDataBean

java.lang.Object

com.ibm.commerce.tools.optools.returns.beans.ReturnSearchDataBean

public class ReturnSearchDataBean
extends java.lang.Object

This databean is used to provide user search capability to the administrative tools. The methods are designed to return filtered lists of returns, based on criteria specified. There is no access control on the methods of this bean. Since the keys returned should be resolved using the corresponding protected databean. For example if returning returns, each user identifier should be used to instantiate a new RMADataBean using the DataBeanManager. To ensure that the appropriate access control check is 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
ReturnSearchDataBean()

Method Summary

Modifier and Type	Method and Description
java.util.Vector	findReturns(WhereClauseCondition aWhereClauseCondition, java.lang.String astrReturnByTableName, java.lang.String astrReturnByFieldName, java.lang.String astrStartIndex, java.lang.String astrMaxResults) This method is the general purpose method for finding returns.
java.util.Vector	findReturns(WhereClauseCondition aWhereClauseCondition, java.lang.String astrReturnByTableName, java.lang.String astrReturnByFieldName, java.lang.String astrStartIndex, java.lang.String astrMaxResults, java.util.List storeIds) This method is the general purpose method for finding returns.
java.util.Vector	findReturns(WhereClauseCondition aWhereClauseCondition, java.lang.String astrReturnByTableName, java.lang.String astrReturnByFieldName, java.lang.String astrStartIndex, java.lang.String astrMaxResults, WhereClauseCondition accessFilterWhereClause) This method is the general purpose method for finding returns.
CommandContext	getCommandContext() This method gets the command context.
java.lang.Integer	getPageSize() This method returns page size.
java.lang.Integer	getResultSize() This method gets the count of all elements matched by this search.
void	setCommandContext(CommandContext aCommandContext) This method sets the command context.
void	setPageSize(java.lang.Integer i) This method sets page size.

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

ReturnSearchDataBean

public ReturnSearchDataBean()

Method Detail

setCommandContext

public void setCommandContext(CommandContext aCommandContext)

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

Parameters:

aCommandContext - The command context.

getCommandContext

public CommandContext getCommandContext()

This method gets the command context.

Returns:

The command context.

getResultSize

public java.lang.Integer getResultSize()

This method gets the count of all elements matched by this search.

Returns:

The result size

findReturns

public java.util.Vector findReturns(WhereClauseCondition aWhereClauseCondition,
                                    java.lang.String astrReturnByTableName,
                                    java.lang.String astrReturnByFieldName,
                                    java.lang.String astrStartIndex,
                                    java.lang.String astrMaxResults)

This method is the general purpose method for finding returns.

Parameters:

aWhereClauseCondition - The where clause conditions.

astrReturnByTableName - The table to order the results by.

astrReturnByFieldName - The field to order the results by.

astrStartIndex - The starting index.

astrMaxResults - The maximum number of results to return.

Returns:

Vector of orders.

findReturns

public java.util.Vector findReturns(WhereClauseCondition aWhereClauseCondition,
                                    java.lang.String astrReturnByTableName,
                                    java.lang.String astrReturnByFieldName,
                                    java.lang.String astrStartIndex,
                                    java.lang.String astrMaxResults,
                                    java.util.List storeIds)

This method is the general purpose method for finding returns.

Parameters:

aWhereClauseCondition - The where clause conditions.

astrReturnByTableName - The table to return the results by.

astrReturnByFieldName - The field to return the results by.

astrStartIndex - The starting index.

astrMaxResults - The maximum number of results to return.

storeIds - A list of store Ids

Returns:

Vector of users.

findReturns

public java.util.Vector findReturns(WhereClauseCondition aWhereClauseCondition,
                                    java.lang.String astrReturnByTableName,
                                    java.lang.String astrReturnByFieldName,
                                    java.lang.String astrStartIndex,
                                    java.lang.String astrMaxResults,
                                    WhereClauseCondition accessFilterWhereClause)

This method is the general purpose method for finding returns. It will retrieve all shoppers with a registered customer role in the specified stores. Access control prefiltering will ensure that only returns that match the access filter where clause will be returned.

Parameters:

aWhereClauseCondition - The where clause conditions.

astrReturnByTableName - The table to return the results by.

astrReturnByFieldName - The field to return the results by.

astrStartIndex - The starting index.

astrMaxResults - The maximum number of results to return.

accessFilterWhereClause - Access filter where clause

Returns:

Vector of users.

setPageSize

public void setPageSize(java.lang.Integer i)

This method sets page size.

Parameters:

i - the page size.

getPageSize

public java.lang.Integer getPageSize()

This method returns page size.

Returns:

the page size.