com.ibm.commerce.order.beans

Class OrderHistoryListDataBean

    • Field Detail

      • COPYRIGHT

        public static final java.lang.String COPYRIGHT
        The IBM copyright notice field.
        See Also:
        Constant Field Values
    • Constructor Detail

      • OrderHistoryListDataBean

        public OrderHistoryListDataBean()
        This is the default constructor for OrderHistoryListDataBean.
      • OrderHistoryListDataBean

        public OrderHistoryListDataBean(java.lang.Long argOrderId)
        This is the constructor for OrderHistoryListDataBean. If the commandContext provided, use OrderHistoryListDataBean(Long argOrderId, CommandContext commandContext) instead.
        Parameters:
        argOrderId - the order id.
      • OrderHistoryListDataBean

        public OrderHistoryListDataBean(java.lang.Long argOrderId,
                                        CommandContext commandContext)
        This is the constructor for OrderHistoryListDataBean.
        Parameters:
        argOrderId - the order id.
        commandContext - the command context.
    • Method Detail

      • getOrderHistoryDataBeansByPageNumber

        public OrderHistoryDataBean[] getOrderHistoryDataBeansByPageNumber(int page)
        This method returns a list of OrderHistory databeans by the page number. Note: page number starts from 1.
        Parameters:
        page - page number.
        Returns:
        the OrderHistoryDataBean[] containing the OrderHistory data beans.
        Throws:
        java.lang.Exception
      • getOrderHistoryDataBeansByPageNumber

        public OrderHistoryDataBean[] getOrderHistoryDataBeansByPageNumber()
        This method returns a list of OrderHistory databeans by the page number set in currentPage Note: page number starts from 1
        Returns:
        the OrderHistoryDataBean[] containing the OrderHistory data beans.
        Throws:
        java.lang.Exception
      • getOrderHistoryDataBeans

        public OrderHistoryDataBean[] getOrderHistoryDataBeans(int startIndex,
                                                               int endIndex)
        This method returns a view of the portion of the list of orderHistories between the specified startIndex, inclusive, and endIndex, exclusive.
        Parameters:
        startIndex - start index
        endIndex - end index
        Returns:
        the OrderHistoryDataBean[] containing the OrderHistory data beans.
        Throws:
        java.lang.Exception
      • setPageSize

        public void setPageSize(int aPageSize)
        This method specifies the page size for getOrderHistoryDataBeansByPageNumber(int pageNumber). Default value is 20.
        Parameters:
        aPageSize - page size, default is 20.
      • setCurrentPage

        public void setCurrentPage(int pageNumber)
        This method sets the current page number - start from 1.
        Parameters:
        pageNumber - The page number to set.
      • setMaxRows

        public void setMaxRows(int argMaxRows)
        This method specifies the maximum number of rows to be returned. Default value is 400 rows.
        Parameters:
        argMaxRows - maximum number of rows to be returned.
      • setAscendingSortOrder

        public void setAscendingSortOrder()
        This method sets ascending sort order.
      • setDescendingSortOrder

        public void setDescendingSortOrder()
        This method sets descending sort order.
      • getSortMethodId

        public int getSortMethodId()
        This method returns the sort method id.
        Returns:
        iSortMethodId the sort method id.
      • setSortMethodId

        public void setSortMethodId(int argSortMethodId)
        This method sets the sort method id.
        Parameters:
        argSortMethodId - The sort method id to set.
      • setOrderByField

        public void setOrderByField(java.lang.String argOrderBy)
        This method sets the order by field.
        Parameters:
        argOrderBy - the order by field.
      • getOrderByField

        public java.lang.String getOrderByField()
        This method gets the order by field.
        Returns:
        strOrderBy the order by field.
      • getResultSetSize

        public int getResultSetSize()
        This method gets the size of the result set.
        Returns:
        The size of the retrieved order list.
      • setResultSetSize

        public void setResultSetSize(int newResultSetSize)
        This method sets the list size of the orders found.
        Parameters:
        newResultSetSize - The size of the order list.