public class OrderHistoryDataBean extends OrderHistoryDataBeanBase implements OrderHistoryInputDataBean, OrderHistorySmartDataBean
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
COPYRIGHT
The IBM copyright notice field.
|
emptyString
Constructor and Description |
---|
OrderHistoryDataBean()
This is the default constructor for OrderHistoryDataBean.
|
OrderHistoryDataBean(OrderHistoryAccessBean argabOrderHistory)
This is the constructor for OrderHistoryDataBean.
|
OrderHistoryDataBean(OrderHistoryAccessBean argabOrderHistory,
CommandContext aCommandContext)
This is the constructor for OrderHistoryDataBean.
|
Modifier and Type | Method and Description |
---|---|
CommandContext |
getCommandContext()
This method gets the command context for this bean.
|
HistoryOrder |
getHistoryOrder()
This method gets the HistoryOrder.
|
java.lang.String |
getOrderByField()
This method gets the order by field.
|
OrderCommentDataBean[] |
getOrderCommentDataBeans(int startIndex,
int endIndex)
This method returns a view of the portion of the list of orderComments between the specified startIndex, inclusive, and endIndex, exclusive.
|
OrderCommentDataBean[] |
getOrderCommentDataBeansByPageNumber()
This method returns a list of orderComment databeans by the page number set in currentPage.
|
OrderCommentDataBean[] |
getOrderCommentDataBeansByPageNumber(int page)
This method returns a list of orderComment databeans by the page number.
|
OrderCommentDataBean[] |
getOrderComments()
This method gets the comments for this order history.
|
TypedProperty |
getRequestProperties()
This method gets the request properties.
|
int |
getResultSetSize()
This method gets the size of the result set.
|
int |
getSortMethodId()
This method returns the inSortMethodId.
|
void |
populate()
This method is used to populate the OrderHistoryDataBean.
|
void |
setAscendingSortOrder()
This method sets ascending sort order.
|
void |
setCommandContext(CommandContext argCommandContext)
This method sets the command context for this bean.
|
void |
setCurrentPage(int pageNumber)
This method sets the current page number.
|
void |
setDescendingSortOrder()
This method sets ascending sort order.
|
void |
setIsOrderCommentFetched(boolean isFetchedAgain)
This method sets the isOrderCommentFetched field for this bean
|
void |
setMaxRows(int argMaxRows)
Specify the maximum number of rows to be returned.
|
void |
setOrderByField(java.lang.String argOrderBy)
This method sets the order by field.
|
void |
setOrderId(java.lang.String argOrderId)
This method sets the order history key field for this bean.
|
void |
setOrderVersion(java.lang.String argOrderVersion)
This method sets the order history key field for this bean.
|
void |
setPageSize(int aPageSize)
This method specifies the page size for getOrderCommentDataBeansByPageNumber(int pageNumber).
|
void |
setRequestProperties(TypedProperty param)
This method sets the request properties.
|
void |
setResultSetSize(int newResultSetSize)
This method sets the list size of the orders found.
|
void |
setSortMethodId(int argSortMethodId)
This method sets the inSortMethodId.
|
getDelegate
findByOrderId, fulfills, getEntity, getField1, getField2, getFiled3, getLastUpdate, getOrderId, getOrderVersion, getOrderXML, getOwner, instantiateEntity, setField1, setField2, setFiled3, setInitKey_orderId, setInitKey_orderVersion, setLastUpdate, setOrderXML
public static final java.lang.String COPYRIGHT
public OrderHistoryDataBean()
public OrderHistoryDataBean(OrderHistoryAccessBean argabOrderHistory)
argabOrderHistory
- OrderHistoryAccessBeanjava.lang.Exception
public OrderHistoryDataBean(OrderHistoryAccessBean argabOrderHistory, CommandContext aCommandContext)
argabOrderHistory
- OrderHistoryDataBeanaCommandContext
- CommandContextjava.lang.Exception
public CommandContext getCommandContext()
getCommandContext
in interface SmartDataBean
com.ibm.commerce.beans.SmartDataBean#getCommandContext()
public void populate()
populate()
method.
populate
in interface SmartDataBean
java.lang.Exception
com.ibm.commerce.beans.SmartDataBean#populate()
,
setOrderId(String)
,
setOrderVersion(String)
public void setCommandContext(CommandContext argCommandContext)
setCommandContext
in interface SmartDataBean
argCommandContext
- the command context.com.ibm.commerce.beans.SmartDataBean#setCommandContext(com.ibm.commerce.command.CommandContext)
public TypedProperty getRequestProperties()
getRequestProperties
in interface InputDataBean
com.ibm.commerce.beans.InputDataBean#getRequestProperties()
public void setRequestProperties(TypedProperty param)
setRequestProperties
in interface InputDataBean
param
- the request properties.com.ibm.commerce.beans.InputDataBean#setRequestProperties(com.ibm.commerce.datatype.TypedProperty)
public void setOrderId(java.lang.String argOrderId)
setOrderId
in interface OrderHistoryInputDataBean
argOrderId
- the order id.OrderHistoryInputDataBean.setOrderId(java.lang.String)
public void setOrderVersion(java.lang.String argOrderVersion)
setOrderVersion
in interface OrderHistoryInputDataBean
argOrderVersion
- the order version.com.ibm.commerce.order.beans.OrderHistoryInputDataBean#setOrderVersion(java.lang.String)
public void setIsOrderCommentFetched(boolean isFetchedAgain)
isFetchedAgain
- This parameter is true if the order comment is fetched; false otherwise.public OrderCommentDataBean[] getOrderComments()
getOrderComments
in interface OrderHistorySmartDataBean
OrderCommentDataBean[]
containing the OrderComment data beans.com.ibm.commerce.order.beans.OrderHistorySmartDataBean#getOrderComments()
public HistoryOrder getHistoryOrder()
public void setPageSize(int aPageSize)
aPageSize
- page size, default is 20.public void setCurrentPage(int pageNumber)
pageNumber
- The page number to set.public void setMaxRows(int argMaxRows)
argMaxRows
- maximum number of rows to be returned.public void setAscendingSortOrder()
public void setDescendingSortOrder()
public int getSortMethodId()
public void setSortMethodId(int argSortMethodId)
argSortMethodId
- The inSortMethodId to set, 0 - by comments ID , 1 - by last update.public OrderCommentDataBean[] getOrderCommentDataBeansByPageNumber(int page)
page
- page numberOrderCommentDataBean[]
containing the OrderComment data beans.java.lang.Exception
public OrderCommentDataBean[] getOrderCommentDataBeansByPageNumber()
OrderCommentDataBean[]
containing the OrderComment data beans.java.lang.Exception
public OrderCommentDataBean[] getOrderCommentDataBeans(int startIndex, int endIndex)
startIndex
- start index.endIndex
- end index.OrderCommentDataBean[]
containing the OrderComment data beans.java.lang.Exception
public void setOrderByField(java.lang.String argOrderBy)
argOrderBy
- the order by field.public java.lang.String getOrderByField()
public int getResultSetSize()
public void setResultSetSize(int newResultSetSize)
newResultSetSize
- The size of the order list.