public class OrderListDataBean extends OrderListDataBeanBase implements com.ibm.commerce.order.beans.OrderListInputDataBean, com.ibm.commerce.order.beans.OrderListSmartDataBean
Mode 1: when order_state is specified.
This DataBean when populated will give a list of Order access beans/databeans. They 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/submission)and status
belonging to the specified user will be returned.
Note: The scope of orders returned can be limited 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) and Channel Store ID (channelStoreId).
Channel Store Order status is described below:
Mode 3: when the fetchCurrentPendingOrder property 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.
Mode 4: when the resolveCurrentPendingOrders property is set to true.
The DataBean when populated will return a list of Orders access beans/databeans for the
orders. These orders belong to the specified user and store, as determined by resolving the
ResolveOrdersCmd.CURRENT_PENDING_ORDERS order abbreviation.
Note: setStartEndDateAndScopeMethod() and setFetchCurrentPendingOrder() will have no effect in Mode 4.
Sorting: There is no sorting by default. To enable sorting setSortMethodId(int sortMethodId) to one of the following values:
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
COPYRIGHT
The IBM copyright notice field.
|
emptyString
Constructor and Description |
---|
OrderListDataBean()
The default constructor.
|
Modifier and Type | Method and Description |
---|---|
boolean |
fulfills(java.lang.Long member,
java.lang.String relationship)
Access control - fulfills
|
java.lang.Integer |
getChannelStoreId()
This method returns the ChannelStoreId.
|
java.lang.String |
getChannelStoreOrderStatus()
This method returns the ChannelStoreOrderStatus.
|
java.lang.String[] |
getChannelStoreOrderStatusList()
This method returns the ChannelStoreOrderStatus.
|
CommandContext |
getCommandContext()
This method returns the command context.
|
PriceDataBean |
getDiscountAdjustedOrdersTotalPrice()
This method returns the subtotal across all the orders in the order list.
|
FormattedQuantityAmountDataBean |
getFormattedOrderItemQuantityTotal()
This method returns the total quantity of all orderitems across all the orders in the orderlist
|
java.util.Vector |
getNonEmptyOrders()
This method returns the list of orders containing one or more order items.
|
int |
getNumberOfOrders()
This method returns the number of orders.
|
OrderDataBean[] |
getOrderDataBeans()
This method returns the list of order data beans.
|
OrderDataBean[] |
getOrderDataBeans(int startIndex,
int endIndex)
This method returns a view of the portion of the list of orders between the specified startIndex, inclusive, and endIndex, exclusive.
|
OrderDataBean[] |
getOrderDataBeansByPageNumber()
Deprecated.
Replaced by
getOrderDataBeansForCurrentPage() |
OrderDataBean[] |
getOrderDataBeansByPageNumber(int page)
Deprecated.
Replaced by
getOrderDataBeansForPage(int pageNumber) |
OrderDataBean[] |
getOrderDataBeansForCurrentPage()
This method returns a list of order databeans by the page number set in currentPage.
|
OrderDataBean[] |
getOrderDataBeansForPage(int pageNumber)
This method returns a list of order databeans by the page number.
|
OrderListDataBean[] |
getOrderListDataBeanSortByDisplayName()
This method 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()
This method returns the list of order access beans.
|
java.lang.String |
getOrderStatus()
This method returns the status of the order.
|
java.lang.String[] |
getOrderStatusList()
This method returns the list of order status.
|
java.lang.Long |
getOwner()
This method returns the owner.
|
int |
getPageSize()
This method returns page size.
|
java.lang.String |
getRelType()
This method returns the relType.
|
TypedProperty |
getRequestProperties()
This method returns the request properties.
|
int |
getSortMethodId()
This method returns he inSortMethodId.
|
java.lang.Integer |
getStoreId()
This method returns store Id.
|
java.lang.Long |
getUserId()
This method returns user Id.
|
boolean |
isEmptyShopCart()
Determines whether the orders contain any order items.
|
boolean |
isFilterExcludeOrdersBlocked()
This method indicates that the list will exclude blocked orders.
|
boolean |
isFilterExcludeOrdersWaitingApproval()
This method indicates where the list of returned orders will exclude orders waiting for approval
|
boolean |
isFilterIncludeOrdersWaitingApproval()
This method indicates that the list of returned orders will include orders waiting for approval
|
boolean |
isFilterOrdersWithNoDescription()
This method returns the filterOrdersWithNoDescription.
|
void |
populate()
This method is used to populate the OrderListDataBean.
|
void |
setAscendingSortOrder()
This method sets ascending sort order.
|
void |
setChannelStoreId(java.lang.Integer paraChannelStoreId)
This method sets the ChannelStoreId.
|
void |
setChannelStoreOrderStatus(java.lang.String istrChannelStoreOrderStatus)
This method sets the ChannelStoreOrderStatus.
|
void |
setChannelStoreOrderStatus(java.lang.String[] astrChannelStoreOrderStatusList)
This method sets the ChannelStoreOrderStatus.
|
void |
setCommandContext(CommandContext acommandContext)
This method sets the command context.
|
void |
setCurrentPage(int pageNumber)
This method sets the current page number.
|
void |
setDescendingSortOrder()
This method sets ascending sort order.
|
void |
setFetchCurrentPendingOrder(boolean trueFalse)
This method specifies whether the databean should be populated with current.
|
void |
setFilterExcludeOrdersBlocked(boolean b)
This method enables/disables a filter that exclude blocked orders from the order list.
|
void |
setFilterExcludeOrdersWaitingApproval(boolean b)
This method enables/disables a filter that will exclude orders waiting for approval from the order list
|
void |
setFilterIncludeOrdersWaitingApproval(boolean b)
This method enables/disables a filter that will include orders waiting for approval
|
void |
setFilterOrdersWithNoDescription(boolean paraFilterOrdersWithNoDescription)
This method sets the filterOrdersWithNoDescription.
|
void |
setMaxRows(int aMaxRows)
This method specifies the maximum number of rows to be returned.
|
void |
setOrderStatus(java.lang.String aStatus)
This method sets the status for retrieving those order of that status.
|
void |
setOrderStatus(java.lang.String[] aStatusList)
This method sets the list of status for retrieving those order.
|
void |
setPageSize(int aPageSize)
This method specifies the page size for getOrderDataBeansByPageNumber(int pageNumber).
|
void |
setRelType(java.lang.String paraIstrRelType)
This method sets the relType.
|
void |
setRequestProperties(TypedProperty aParam)
This method sets the request properties.
|
void |
setResolveCurrentPendingOrders(boolean trueFalse)
This method specifies whether the databean should be populated with current
pending orders resolved from the ResolveOrdersCmd.CURRENT_PENDING_ORDERS order abbreviation.
|
void |
setRetrievalOrderStatus(java.lang.String aStatus)
This method sets the status for retrieving those order of that status.
|
void |
setSortMethodId(int paraInSortMethodId)
This method sets the inSortMethodId.
|
void |
setStartEndDateAndScopeMethod(java.sql.Timestamp argStartDate,
java.sql.Timestamp argEndDate,
int argScopeMethod)
This method specifies the start and end date to be used to limit the scope of Orders retrieval.
|
void |
setStoreId(java.lang.Integer aStoreId)
This method sets the store Id for retrieving those order of that store.
|
void |
setStoreId(java.lang.Integer[] aStoreIdList)
This method sets the store Id for retrieving those order of that store.
|
void |
setUserId(java.lang.Long aUserId)
This method sets the user Id for retrieving those order of that user.
|
getDelegate
clearOrderItemsCache, findByMember, findByMemberForUpdate, findByOrderForUpdate, findByOrderIds, findByStatus, findByStatusAndMember, findByStatusAndMemberScopedByLastUpdate, findByStatusAndMemberScopedByTimePlaced, findByStatusesMemberStoreHostedAtChannelStartEndDateAndDateField, findByStatusesMemberStoresRelTypeStartEndDateAndDateField, findByStatusesMemberStoresStartEndDateAndDateField, findByStatusMemberAndRelType, findByStatusMemberAndRelTypeScopedByLastUpdate, findByStatusMemberAndRelTypeScopedByTimePlaced, findByStatusMemberAndStore, findByStatusMemberAndStoreForUpdate, findByStatusMemberAndStoreHostedAtChannel, findByStatusMemberAndStoreScopedByLastUpdate, findByStatusMemberAndStoreScopedByTimePlaced, findByStatusMemberRelTypeAndStore, findByStatusMemberRelTypeAndStoreScopedByLastUpdate, findByStatusMemberRelTypeAndStoreScopedByTimePlaced, findByStatusStoreentIdAndDescription, findByStoreIdMemberIdAndStatus, findChildOrderByDistributorStoreIdsAndOrdersIdAndRelType, findCurrentPendingOrders, findCurrentPendingOrdersByMember, findCurrentPendingOrdersByMemberAndStore, findFullyTransferredOrdersByChannelStoreIdAndShopperId, findFullyTransferredOrdersByChannelStoreIdShopperIdStartEndDateAndDateField, findNotTransferredOrdersByChannelStoreIdAndShopperId, findNotTransferredOrdersByChannelStoreIdShopperIdStartEndDateAndDateField, findOrders, findOrderTemplatesByMember, findOrderTemplatesByMemberAndUsage, findOrderTemplatesByStoreAndMember, findOrderTemplatesByStoreMemberAndUsage, findParentOrderByOrdersId, findPartlyTransferredOrdersByChannelStoreIdAndShopperId, findPartlyTransferredOrdersByChannelStoreIdShopperIdStartEndDateAndDateField, findPendingOrders, findPrivateRequisitionListByMember, findPrivateRequisitionListByMember, findPrivateRequisitionListByMemberAndStore, findPrivateRequisitionListByMemberAndStore, findPrivateRequisitionListByMemberAndStoreHostedAtChannel, findPrivateRequisitionListByMemberAndStoreHostedAtChannel, findPrivateRequisitionListByMemberOrderByLastUpdate, findProcessedOrdersByChannelStoreIdAndShopperId, findProcessedOrdersByChannelStoreIdShopperIdStartEndDateAndDateField, findShareableRequisitionListByMember, findShareableRequisitionListByMemberAndStore, findShareableRequisitionListByMemberAndStoreHostedAtChannel, findShareableRequisitionListByOrg, findShareableRequisitionListByOrgAndStore, findShareableRequisitionListByOrgAndStoreHostedAtChannel, findShareableRequisitionListOwnedByMember, findShareableRequisitionListOwnedByMember, findShareableRequisitionListOwnedByMemberAndStore, findShareableRequisitionListOwnedByMemberAndStore, findShareableRequisitionListOwnedByMemberAndStoreHostedAtChannel, findShareableRequisitionListOwnedByMemberAndStoreHostedAtChannel, findTemplatedOrdersByStoreIdMemberIdAndUsage, findWithParameterizedPushDownQuery, findWithPushDownQuery, getActualShipDate, getAddressId, getAddressIdInEntityType, getBuschnId, getComment, getCurrency, getDescription, getEditorId, getEntity, getEstimatedOrPromisedShipDate, getEstimatedShipDate, getExpireDate, getField1, getField1InEntityType, getField2, getField2InEntityType, getField3, getGroupingAttributeValue, getIsBlocked, getIsBlockedInEntityType, getLastUpdate, getLastUpdateInEntityType, getLock, getMemberId, getMemberIdInEntityType, getMerchantOrderId, getNotificationId, getNotificationIdInEntityType, getOrderChannelTypeId, getOrderChannelTypeIdInEntityType, getOrderId, getOrderIdInEntityType, getOrderItems, getOrderItemsByFulfillmentStatus, getOrderItemsByFulfillmentStatusForUpdate, getOrderItemsForUpdate, getOrderItemsSortedByCatalogEntryId, getOrderItemsSortedByOrderItemId, getOrderProcessSystemId, getOrganizationId, getOrganizationIdInEntityType, getPlaceOrderTime, getPlaceOrderTimeInEntityType, getPromisedShipDate, getProviderOrderNumber, getProviderOrderNumberInEntityType, getPurchaseOrderId, getSequence, getSequenceInEntityType, getShipAsComplete, getSourceId, getStatus, getStoreEntityId, getStoreEntityIdInEntityType, getSubOrders, getTotalAdjustment, getTotalAdjustmentByCalculationUsageId, getTotalAdjustmentByCalculationUsageIdAndDisplayLevel, getTotalAdjustmentByDisplayLevel, getTotalAdjustmentInEntityType, getTotalProductPrice, getTotalProductPriceInEntityType, getTotalShippingCharge, getTotalShippingChargeInEntityType, getTotalShippingTax, getTotalShippingTaxInEntityType, getTotalTax, getTotalTaxInEntityType, getTransferStatus, getType, instantiateEntity, setAddressId, setAddressId, setBuschnId, setComment, setCurrency, setDescription, setEditorId, setExpireDate, setField1, setField1, setField2, setField2, setField3, setInitKey_orderId, setInitKey_orderId, setIsBlocked, setIsBlocked, setLastUpdate, setLastUpdate, setLastUpdateWithoutCheck, setLock, setMemberId, setMemberId, setMerchantOrderId, setNotificationId, setNotificationId, setOrderChannelTypeId, setOrderChannelTypeId, setOrderProcessSystemId, setOrganizationId, setOrganizationId, setPlaceOrderTime, setPlaceOrderTime, setProviderOrderNumber, setProviderOrderNumber, setPurchaseOrderId, setSequence, setSequence, setShipAsComplete, setSourceId, setStatus, setStoreEntityId, setStoreEntityId, setTotalAdjustment, setTotalAdjustment, setTotalProductPrice, setTotalProductPrice, setTotalShippingCharge, setTotalShippingCharge, setTotalShippingTax, setTotalShippingTax, setTotalTax, setTotalTax, setTransferStatus, setType
public static final java.lang.String COPYRIGHT
public CommandContext getCommandContext()
getCommandContext
in interface SmartDataBean
com.ibm.commerce.command.CommandContext
.public java.util.Vector getOrders()
getOrders
in interface com.ibm.commerce.order.beans.OrderListSmartDataBean
Vector
containing the order access beans.public java.util.Vector getNonEmptyOrders()
Vector
containing the order data 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)
getOrderDataBeansForPage(int pageNumber)
page
- page numberpublic OrderListDataBean[] getOrderListDataBeanSortByDisplayName()
public java.lang.String getOrderStatus()
getOrderStatus
in interface com.ibm.commerce.order.beans.OrderListSmartDataBean
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
getOwner
in interface Protectable
getOwner
in class OrderAccessBean
java.lang.Exception
public TypedProperty getRequestProperties()
getRequestProperties
in interface InputDataBean
com.ibm.commerce.datatype.TypedProperty
containing the
request properties.public PriceDataBean getDiscountAdjustedOrdersTotalPrice()
com.ibm.commerce.price.databeans.PriceDataBean
with the subtotal of all the orders in the listpublic FormattedQuantityAmountDataBean getFormattedOrderItemQuantityTotal()
com.ibm.commerce.price.beans.FormattedQuantityAmountDataBean
with the number of orderitems
across all the orders in the orderlistpublic void populate() throws java.lang.Exception
populate
in interface SmartDataBean
java.lang.Exception
public void setCommandContext(CommandContext acommandContext)
setCommandContext
in interface SmartDataBean
acommandContext
- com.ibm.commerce.command.CommandContext.public void setOrderStatus(java.lang.String aStatus)
setOrderStatus
in interface com.ibm.commerce.order.beans.OrderListInputDataBean
aStatus
- the order status or a comma-delimited list of order statuspublic void setRetrievalOrderStatus(java.lang.String aStatus)
aStatus
- the order status or a comma-delimited list of order statuspublic void setOrderStatus(java.lang.String[] aStatusList)
aStatusList
- list of order status.public void setRequestProperties(TypedProperty aParam)
setRequestProperties
in interface InputDataBean
aParam
- com.ibm.commerce.datatype.TypedProperty.public void setStoreId(java.lang.Integer aStoreId)
setStoreId
in interface com.ibm.commerce.order.beans.OrderListInputDataBean
aStoreId
- the order Id.public java.lang.Integer getStoreId()
public void setStoreId(java.lang.Integer[] aStoreIdList)
aStoreIdList
- the Store Ids.public java.lang.Long getUserId()
public int getPageSize()
public void setUserId(java.lang.Long aUserId)
setUserId
in interface com.ibm.commerce.order.beans.OrderListInputDataBean
aUserId
- the user Id.public boolean fulfills(java.lang.Long member, java.lang.String relationship) throws java.lang.Exception
fulfills
in interface Protectable
fulfills
in class OrderAccessBean
member
- java.lang.Longrelationship
- java.lang.Stringjava.lang.Exception
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 paraChannelStoreId)
paraChannelStoreId
- The ChannelStoreId to setpublic java.lang.String getRelType()
public void setRelType(java.lang.String paraIstrRelType)
paraIstrRelType
- The istrRelType to setpublic int getSortMethodId()
public void setSortMethodId(int paraInSortMethodId)
paraInSortMethodId
- The inSortMethodId to setpublic void setAscendingSortOrder()
public void setDescendingSortOrder()
public void setResolveCurrentPendingOrders(boolean trueFalse)
trueFalse
- fetch current pending orders or notpublic void setFetchCurrentPendingOrder(boolean trueFalse)
trueFalse
- fetch current pending order or notpublic 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 paraFilterOrdersWithNoDescription)
paraFilterOrdersWithNoDescription
- The filterOrdersWithNoDescription to setpublic boolean isEmptyShopCart()
public void setCurrentPage(int pageNumber)
pageNumber
- The page number to setpublic OrderDataBean[] getOrderDataBeansByPageNumber()
getOrderDataBeansForCurrentPage()
public OrderDataBean[] getOrderDataBeansForCurrentPage()
public OrderDataBean[] getOrderDataBeansForPage(int pageNumber)
pageNumber
- page numberpublic boolean isFilterExcludeOrdersBlocked()
public boolean isFilterExcludeOrdersWaitingApproval()
public boolean isFilterIncludeOrdersWaitingApproval()
public void setFilterExcludeOrdersBlocked(boolean b)
b
- (true or false)public void setFilterExcludeOrdersWaitingApproval(boolean b)
b
- (true or false)public void setFilterIncludeOrdersWaitingApproval(boolean b)
b
- (true or false)