java.lang.Object | +--com.ibm.commerce.order.beansrc.OrderListDataBeanBase | +--com.ibm.commerce.order.beans.OrderListDataBean
The OrderListDataBean can operate in three modes depending on the values of order_state,channelStoreId, and currentPendingOrders: Mode 1: when order_state is specified This DataBean when populated will give a list of Order access beans/databeans for those orders that are of the specified status,user, and/or the specified stores. If relType is specified, only orders of the specified relType(initial/selection/final/submmission)and status belonging to the specified user will be returned. Note: The orders returned can be scoped by date using setStartEndDateAndScopeMethod() Mode 2: when channelStoreId is specified The OrderListDataBean can also be used to retrieve Order access beans by Channel Store Order status(channelStoreOrderStatus) described below a = not transferred b = partly transferred c = fully transferred d = processed and Channel Store ID (channelStoreId) Note: setStartEndDateAndScopeMethod(1) is the only supported scoping option Note: For mode a (not transferred orders) and b (partly transferred orders), there is an option to filter out orders that do not have a description. To enable filtering, use setFilterOrdersWithNoDescription(boolean) Mode 3: when currentPendingOrders is set to true The DataBean when populated will return a list of Orders access beans/databeans for the orders that belong to the specified user and store. Note: setStartEndDateAndScopeMethod() will have no effect in Mode 3 Sorting: There is no sorting by default. To enable sorting setSortMethodId(int sortMethodId) to one of the following values: 0=no sorting 1=sort by lastupdate 2=sort by storeentId 3=sort by status P,W,N,F,G,S 4=sort by order description 5=sort by distributor order number 6=sort by display name 7=sort by order id 8=sort by order status and order fulfillment status Sorting order {"P", "W", "N", "F", "G-C","G-S", "G-I" "S"}. "G-C" means that orders.status=G and ordstat.ostatus="C". Similarily, " G-S" and "G-I" means orders.status=G and ordstat.ostatus="S" and "I" respectively. 9=sort by timeplaced 10=sort by timeplaced and lastupdate(timeplace takes precedence,if timeplaced is null, use lastupdate) To modify the sorting order: use setAscendingSortOrder() or setDescendingSortOrder()
Field Summary | |
---|---|
static java.lang.String |
COPYRIGHT The internal copyright field. |
Constructor Summary | |
---|---|
OrderListDataBean() OrderListDataBean constructor comment. |
Method Summary | |
---|---|
boolean |
fulfills(java.lang.Long member,
java.lang.String relationship) Access control - fulfills |
java.lang.Integer |
getChannelStoreId() Gets the ChannelStoreId |
java.lang.String |
getChannelStoreOrderStatus() Gets the ChannelStoreOrderStatus a = not transferred b = partly transferred c = fully transferred d = processed |
java.lang.String[] |
getChannelStoreOrderStatusList() Gets the ChannelStoreOrderStatus a = not transferred b = partly transferred c = fully transferred d = processed |
CommandContext |
getCommandContext() Get the command context. |
int |
getNumberOfOrders() Get the number of orders |
OrderDataBean[] |
getOrderDataBeans() Get the list of order data beans. |
OrderDataBean[] |
getOrderDataBeans(int startIndex, int endIndex) Returns a view of the portion of the list of orders between the specified startIndex, inclusive, and endIndex, exclusive. |
OrderDataBean[] |
getOrderDataBeansByPageNumber(int page) Returns a list of order databeans by the page number Note: page number starts from 1 |
OrderListDataBean[] |
getOrderListDataBeanSortByDisplayName() Returns Vector of orderlist databeans grouped by distributor display name Side Effect: SortMethodId will be set to 6, and the orders will be sorted by display name |
java.util.Vector |
getOrders() Get the list of order access beans. |
java.lang.String |
getOrderStatus() Get the status of the order. |
java.lang.String[] |
getOrderStatusList() Get the list of order status |
java.lang.Long |
getOwner() Get owner |
java.lang.String |
getRelType() Gets the relType |
TypedProperty |
getRequestProperties() Get the request properties. |
int |
getSortMethodId() Gets the inSortMethodId |
java.lang.Integer |
getStoreId() Returns store Id |
boolean |
isFilterOrdersWithNoDescription() Returns the filterOrdersWithNoDescription. |
void |
populate() Provides a list of Order AccessBean for those orders that are of the specified status and/or the specified stores. |
void |
setAscendingSortOrder() Sets ascending sort order |
void |
setChannelStoreId(java.lang.Integer inChannelStoreId) Sets the ChannelStoreId |
void |
setChannelStoreOrderStatus(java.lang.String istrChannelStoreOrderStatus) Sets the ChannelStoreOrderStatus a = not transferred b = partly transferred c = fully transferred d = processed |
void |
setChannelStoreOrderStatus(java.lang.String[] astrChannelStoreOrderStatusList) Sets the ChannelStoreOrderStatus a = not transferred b = partly transferred c = fully transferred d = processed |
void |
setCommandContext(
CommandContext acommandContext) Set the command context. |
void |
setDescendingSortOrder() Sets ascending sort order |
void |
setFetchCurrentPendingOrder(boolean trueFalse) Specify whether the databean should be populated with current pending orders with this method |
void |
setFilterOrdersWithNoDescription(boolean filterOrdersWithNoDescription) Sets the filterOrdersWithNoDescription. |
void |
setMaxRows(int aMaxRows) Specify the maximum number of rows to be returned Default value is 400 rows |
void |
setOrderStatus(java.lang.String aStatus) Set the status for retrieving those order of that status. |
void |
setOrderStatus(java.lang.String[] aStatusList) Set the list of status for retrieving those order. |
void |
setPageSize(int aPageSize) Specify the page size for getOrderDataBeansByPageNumber(int pageNumber) Default value is 20 |
void |
setRelType(java.lang.String istrRelType) Sets the relType |
void |
setRequestProperties(
TypedProperty aParam) Set the request properties. |
void |
setSortMethodId(int inSortMethodId) Sets the inSortMethodId |
void |
setStartEndDateAndScopeMethod(java.sql.Timestamp argStartDate,
java.sql.Timestamp argEndDate, int argScopeMethod) Specify the start and end date to be used to limit the scope of Orders retrieval Scope Method 1: start and end date will be compared with the lastupdate field Scope Method 2: start and end date will be compare with the timeplaced field Scope Method 3: start and end date will be compared with the timeplaced field, if timeplcaed is null, lastupdate will be used instead. |
void |
setStoreId(java.lang.Integer aStoreId) Set the store Id for retrieving those order of that store. |
void |
setStoreId(java.lang.Integer[] aStoreIdList) Set the store Id for retrieving those order of that store. |
void |
setUserId(java.lang.Long aUserId) Set the user Id for retrieving those order of that user. |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll,
toString, wait, wait, wait |
Field Detail |
---|
public static final java.lang.String COPYRIGHT
Constructor Detail |
---|
public OrderListDataBean()
Method Detail |
---|
public CommandContext getCommandContext()
com.ibm.commerce.command.CommandContext
.public java.util.Vector getOrders()
Vector
containing the order access
beans.public int getNumberOfOrders()
int
public OrderDataBean[] getOrderDataBeans()
OrderDataBean[]
containing the order data
beans.public OrderDataBean[] getOrderDataBeans(int startIndex, int endIndex)
startIndex
- start indexendIndex
- end indexOrderDataBean[]
containing the order data
beans.public void setPageSize(int aPageSize)
aPageSize
- page size, default is 20public OrderDataBean[] getOrderDataBeansByPageNumber(int page)
page
- page numberpublic OrderListDataBean[] getOrderListDataBeanSortByDisplayName()
public java.lang.String getOrderStatus()
String
representing the order status.public java.lang.String[] getOrderStatusList()
String[]
representing the list of order
status.public java.lang.Long getOwner() throws java.lang.Exception, java.rmi.RemoteException, javax.ejb.FinderException, javax.naming.NamingException
java.lang.Exception
java.rmi.RemoteException
javax.ejb.FinderException
javax.naming.NamingException
public TypedProperty getRequestProperties()
com.ibm.commerce.datatype.TypedProperty
containing the
request properties.public void populate() throws java.lang.Exception
java.lang.Exception
public void setCommandContext(CommandContext acommandContext)
public void setOrderStatus(java.lang.String aStatus)
aStatus
- the order status.public void setOrderStatus(java.lang.String[] aStatusList)
aStatusList
- list of order status.public void setRequestProperties(TypedProperty aParam)
public void setStoreId(java.lang.Integer aStoreId)
aStoreId
- the order Id.public java.lang.Integer getStoreId()
public void setStoreId(java.lang.Integer[] aStoreIdList)
public void setUserId(java.lang.Long aUserId)
aUserId
- the user Id.public boolean fulfills(java.lang.Long member, java.lang.String relationship) throws java.rmi.RemoteException, java.lang.Exception, javax.ejb.FinderException, javax.naming.NamingException
java.rmi.RemoteException
java.lang.Exception
javax.ejb.FinderException
javax.naming.NamingException
public java.lang.String getChannelStoreOrderStatus()
public void setChannelStoreOrderStatus(java.lang.String istrChannelStoreOrderStatus)
istrChannelStoreOrderStatus
- The istrChannelStoreOrderStatus
to setpublic java.lang.String[] getChannelStoreOrderStatusList()
public void setChannelStoreOrderStatus(java.lang.String[] astrChannelStoreOrderStatusList)
astrChannelStoreOrderStatusList
- The
astrChannelStoreOrderStatusList to setpublic java.lang.Integer getChannelStoreId()
public void setChannelStoreId(java.lang.Integer inChannelStoreId)
inChannelStoreId
- The inChannelStoreId to
setpublic java.lang.String getRelType()
public void setRelType(java.lang.String istrRelType)
public int getSortMethodId()
public void setSortMethodId(int inSortMethodId)
inSortMethodId
- The inSortMethodId to setpublic void setAscendingSortOrder()
public void setDescendingSortOrder()
public void setFetchCurrentPendingOrder(boolean trueFalse)
public void setStartEndDateAndScopeMethod(java.sql.Timestamp argStartDate, java.sql.Timestamp argEndDate, int argScopeMethod)
argStartDate
- start dateargEndDate
- end dateargScopeMethod
- scope method idpublic void setMaxRows(int aMaxRows)
aMaxRows
- maximum number of rows to be
returnedpublic boolean isFilterOrdersWithNoDescription()
public void setFilterOrdersWithNoDescription(boolean filterOrdersWithNoDescription)
filterOrdersWithNoDescription
- The
filterOrdersWithNoDescription to set