com.ibm.commerce.tools.optools.order.helpers
Class OrderItemSearchAccessBean

java.lang.Object
  |
  +--com.ibm.ivj.ejb.runtime.AbstractAccessBean
        |
        +--com.ibm.ivj.ejb.runtime.AbstractSessionAccessBean
              |
              +--com.ibm.commerce.tools.optools.order.helpers.OrderItemSearchAccessBean
All Implemented Interfaces:
java.io.Serializable

public class OrderItemSearchAccessBean
extends com.ibm.ivj.ejb.runtime.AbstractSessionAccessBean

This bean is used for searching the ORDERITEMS table.

It is used to get a list of order items satisfying specific search criteria based on input parameters.

Mainly used for searching order items in the Commerce Accelerator orders and returns User Interface.

See Also:
Serialized Form

Fields inherited from class com.ibm.ivj.ejb.runtime.AbstractAccessBean
DEFAULT_NAMESERVICE_PROVIDER_URL, DEFAULT_NAMESERVICE_TYPE, ejbRef
 
Constructor Summary
OrderItemSearchAccessBean()
          Default constructor.
OrderItemSearchAccessBean(javax.ejb.EJBObject object)
          Creates an access bean for the specified EJB.
 
Method Summary
 com.ibm.commerce.tools.optools.common.helpers.DynamicListData findOrderItemsByOrderIdLogonId(java.lang.String[] orderIds, java.lang.String logonId, java.lang.String orgId, java.lang.String orderBy, java.lang.String langId, java.lang.String storeId)
          This finder method queries the ORDERITEMS table depending on the search criterias specified.
 
Methods inherited from class com.ibm.ivj.ejb.runtime.AbstractAccessBean
defaultJNDIName, defaultNameServiceType, defaultNameServiceURL, getEJBRef, getGlobalHome, getHome, getInit_GlobalNameServiceTypeName, getInit_GlobalNameServiceURLName, getInit_JNDIName, getInit_NameServiceTypeName, getInit_NameServiceURLName, getInitContext, getInitContext, instantiateEJB, resetEJBRef, resetHomeCache, setEJBRef, setInit_GlobalNameServiceTypeName, setInit_GlobalNameServiceURLName, setInit_JNDIName, setInit_NameServiceTypeName, setInit_NameServiceURLName
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

OrderItemSearchAccessBean

public OrderItemSearchAccessBean()

Default constructor.


OrderItemSearchAccessBean

public OrderItemSearchAccessBean(javax.ejb.EJBObject object)
                          throws java.rmi.RemoteException

Creates an access bean for the specified EJB.

Parameters:
object - The EJB Object used for the access bean construction.
Throws:
java.rmi.RemoteException - The java.rmi.RemoteException exception
Method Detail

findOrderItemsByOrderIdLogonId

public com.ibm.commerce.tools.optools.common.helpers.DynamicListData findOrderItemsByOrderIdLogonId(java.lang.String[] orderIds,
                                                                                                    java.lang.String logonId,
                                                                                                    java.lang.String orgId,
                                                                                                    java.lang.String orderBy,
                                                                                                    java.lang.String langId,
                                                                                                    java.lang.String storeId)
                                                                                             throws javax.naming.NamingException,
                                                                                                    javax.ejb.CreateException,
                                                                                                    java.sql.SQLException,
                                                                                                    javax.ejb.FinderException,
                                                                                                    java.rmi.RemoteException

This finder method queries the ORDERITEMS table depending on the search criterias specified. If all of these parameters, orderIds, logonId and orgId, are null or empty, it returns null.

The SQL query executed depends on the input parameters. A sample query where all input parameters are given:

SELECT DISTINCT ORDERITEMS_ID FROM ORDERITEMS, STORECENT, USERREG

WHERE (STORECENT.STOREENT_ID = ?) AND (STORECENT.CATENTRY_ID = ORDERITEMS.CATENTRY_ID) AND (USERREG.USERS_ID = ORDERITEMS.MEMBER_ID) AND (ORDERS_ID IN ?) AND ((USERREG.LOGONID LIKE ? ESCAPE '\\') OR (USERREG.LOGONID LIKE ? ESCAPE '\\')) AND (ORDERS_ID IN (SELECT ORDERS_ID FROM ORDERS WHERE ORDERS.ORGENTITY_ID = ?)) ORDER BY ?

The possible values for orderBy are:

Parameters:
orderIds - (Optional) An array of orderIds that the resulting order items should belong to.
logonId - (Optional) The customer logon id.
orgId - (Optional) The organization reference number.
orderBy - The parameter to sort the resulting data by.
langId - The language id.
storeId - Limit the search to the store specified.
Returns:
com.ibm.commerce.tools.optools.common.helpers.DynamicListData List of data used by the Commerce Accelerator UI
Throws:
javax.naming.NamingException - The javax.naming.NamingException exception
javax.ejb.CreateException - The javax.ejb.CreateException exception
java.sql.SQLException - The java.sql.SQLException exception
javax.ejb.FinderException - The javax.ejb.FinderException exception
java.rmi.RemoteException - The java.rmi.RemoteException exception