public class ShowSalesOrder extends SalesOrder implements IShowSalesOrder
Modifier and Type | Field and Description |
---|---|
static java.lang.String | CLASSNAME
Class name field.
|
static java.lang.String | COPYRIGHT
IBM Copyright notice field
|
Constructor and Description |
---|
ShowSalesOrder()
Default constructor.
|
Modifier and Type | Method and Description |
---|---|
protected void | buildDataArea()
This method builds the data area subsection of the response BOD based on the parameters passed with search criteria.
|
protected void | buildDataAreaForHistoryOrder(SearchCriteria searchCriteria)
This method builds the Data Area subsection of the response BOD when the history order is requested along with the order items.
|
protected void | buildDataAreaForSalesOrder(SearchCriteria searchCriteria)
This method builds the Data Area subsection of the response BOD when the Sales order is requested along with the order items.
|
protected void | buildDataAreaForSalesOrderItems(SearchCriteria searchCriteria)
This method builds the Data Area subsection of the response BOD when only order items are requested.
|
protected org.w3c.dom.Element | buildNounElementDetailInfoForHistory(org.w3c.dom.Element aParentElement, OrderBaseSearchResultBean orderSearchResultBean)
This method builds the detailed information for this noun.
|
protected org.w3c.dom.Element | buildNounElementForHistory(org.w3c.dom.Element aParent, java.lang.String astrNounTagName, OrderBaseSearchResultBean orderSearchResultBean)
This method builds the common child elements for this noun.
|
protected org.w3c.dom.Element | createAcknowledgementDetailElementForHistory(org.w3c.dom.Element aParentElement)
This method creates the oa:AcknowledgementDetail element for an older version of the order.
|
protected org.w3c.dom.Element | createAddressesElementForHistory(HistoryOrder historyOrder, java.lang.String paymentTCId, org.w3c.dom.Element aParentElement)
This method builds the Addresses element for an older version of the order.
|
protected org.w3c.dom.Element | createAvailablePaymentMethodsElementForHistory(HistoryOrder historyOrder, org.w3c.dom.Element aParentElement)
This method creates the AvailablePaymentMethods element for an older version of the order.
|
protected org.w3c.dom.Element | createAvailableShippingModesElementForHistory(org.w3c.dom.Element aParentElement)
This method builds the AvailShippingModes element for the older version of the order.
|
protected org.w3c.dom.Element | createAvailableShippingModesElementForHistory(org.w3c.dom.Element aParentElement, HistoryOrderItem item)
This method builds the AvailShippingModes element for the older version of the order.
|
protected org.w3c.dom.Element | createBillToPartyElementForHistory(OrderBaseSearchResultBean abnOrderBaseSearchResult, org.w3c.dom.Element aParentElement)
This method builds the BillToParty element for an older version of the order.
|
protected org.w3c.dom.Element | createBusinessChannelElementForHistory(OrderBaseSearchResultBean abnSearchResult, org.w3c.dom.Element aParentElement)
This method creates the BusinessChannel element.
|
protected org.w3c.dom.Element | createChargesElementForHistory(org.w3c.dom.Element aParentElement)
This method creates the Charges element for an older version of the order.
|
protected org.w3c.dom.Element | createChargesElementForHistory(org.w3c.dom.Element aParentElement, OrderBaseSearchResultBean orderSearchResultBean)
This method creates the Charges element for an older version of the order.
|
protected org.w3c.dom.Element | createContractIDElementForHistory(org.w3c.dom.Element aParentElement, HistoryOrderItem historyOrderItem)
This method creates elements related to the contract ID for an order item in the older version of the order.
|
protected org.w3c.dom.Element | createCustomerPartyElementForHistory(OrderBaseSearchResultBean abnOrderBaseSearchResult, org.w3c.dom.Element aParentElement)
This method builds the CustomerParty element for an older version of the order.
|
protected org.w3c.dom.Element | createElectronicCatalogElementForHistory(org.w3c.dom.Element aParentElement, HistoryOrderItem historyOrderItem, OrderBaseSearchResultBean obsrb)
This method builds the ElectronicCatalog element for the older version of the order.
|
protected org.w3c.dom.Element | createHeaderElementForHistory(org.w3c.dom.Element aParentElement, OrderBaseSearchResultBean orderSearchResultBean)
This method creates the Header element for an older version of the order.
|
protected org.w3c.dom.Element | createHistoryExtendedPriceElementForHistory(org.w3c.dom.Element aParentElement, java.lang.String astrPrice, java.lang.String astrCurrency)
This method builds the ExtendedPrice element for an older version of the order.
|
protected org.w3c.dom.Element | createIsExpediteElementForHistory(org.w3c.dom.Element aParentElement, HistoryOrderItem historyOrderItem)
This method creates the ExpediteOrderItem element for an order item in an older version of the order.
|
protected org.w3c.dom.Element | createItemShippedElementForHistory(org.w3c.dom.Element aParentElement)
This method creates the Shipped element for the order item in the older version of the order.
|
protected org.w3c.dom.Element | createLineElementForHistory(org.w3c.dom.Element aParentElement, OrderBaseSearchResultBean abnOrderBaseSearchResult)
This method builds the Line element for the older version of the order.
|
protected org.w3c.dom.Element | createNeedToDeliveryDateElementForHistory(org.w3c.dom.Element aParentElement, HistoryOrderItem historyOrderItem)
This method creates the NeedToDeliveryDate for an order item in an older version of the order.
|
protected org.w3c.dom.Element | createOrderBlockElementForHistory(org.w3c.dom.Element aParentElement, HistoryOrderBlock abnOrderBlock)
This method creates the OrderBlock element for an older version of the order.
|
protected org.w3c.dom.Element | createOrderBlocksElementForHistory(OrderBaseSearchResultBean abnSearchResult, org.w3c.dom.Element aParentElement)
This method creates the OrderBlocks element for an older version of the order.
|
protected org.w3c.dom.Element | createOrderCurrentChargesElementForHistory(OrderBaseSearchResultBean abnSearchResult, org.w3c.dom.Element aParentElement)
This method builds the OrderCurrentCharges element for an older version of the order.
|
protected org.w3c.dom.Element | createOrderEditableElementForHistory(org.w3c.dom.Element aParentElement)
This method creates the UserArea element inside the oa:OrderStatus element for an older version of the order.
|
protected org.w3c.dom.Element | createOrderItemElementForHistory(org.w3c.dom.Element aParentElement, HistoryOrderItem bnHistoryOrderItem)
This method builds the OrderItem element for an order item in an older version of the order.
|
protected org.w3c.dom.Element | createOrderItemStatusElementForHistory(org.w3c.dom.Element aParentElement)
This method creates the OrderStatus element for an order item in an older version of the order.
|
protected org.w3c.dom.Element | createOrderShippingInformationElementForHistory(org.w3c.dom.Element aParentElement, OrderBaseSearchResultBean abnOrderBaseSearchResult)
This method creates the OrderShippingInformation Element and its sub-elements for the older version of the order.
|
protected org.w3c.dom.Element | createOrderStatusElementForHistory(HistoryOrder historyOrder, org.w3c.dom.Element aParentElement)
This method creates the OrderStatus element for an older version of the order.
|
protected org.w3c.dom.Element | createOrderUnpaidBalanceElementForHistory(OrderBaseSearchResultBean abnSearchResult, org.w3c.dom.Element aParentElement)
This method builds the OrderUnpaidBalance element for an older version of the order.
|
protected org.w3c.dom.Element | createPartiesElementForHistory(org.w3c.dom.Element aParentElement, HistoryOrderItem historyOrderItem)
This method builds the Parties element for an order item in an older version of the order.
|
protected org.w3c.dom.Element | createPartiesElementForHistory(OrderBaseSearchResultBean abnOrderBaseSearchResult, org.w3c.dom.Element aParentElement)
This method builds the Parties element for an older version of the order.
|
protected org.w3c.dom.Element | createPaymentInstructionElementForHistory(java.util.HashMap ahashProtocolData, EDPPaymentInstruction aPiData, org.w3c.dom.Element aParentElement)
This method builds the PaymentInstruction element for an older version of the order.
|
protected org.w3c.dom.Element | createPaymentTermsElementForHistory(org.w3c.dom.Element aParentElement, HistoryOrderItem historyOrderItem)
This method creates the PaymentTerms element for an order item in the older version of the order.
|
protected org.w3c.dom.Element | createPaymentTermsElementForHistory(HistoryOrder historyOrder, org.w3c.dom.Element aParentElement)
This method creates the PaymentTerms element for an older version of the order.
|
protected void | createQuoteExpireDateElementForHistory(OrderBaseSearchResultBean abnOrderBaseSearchResult, org.w3c.dom.Element headerElement)
This method builds the ExpireDate element.
|
protected org.w3c.dom.Element | createQuoteExpiryPeriodElementForHistory(OrderBaseSearchResultBean abnOrderBaseSearchResult, org.w3c.dom.Element headerElement)
This method builds the ExpirePeriod element.
|
protected org.w3c.dom.Element | createSalesOrderElementForHistory(org.w3c.dom.Element aParent, OrderBaseSearchResultBean orderSearchResultBean)
This method creates SalesOrder element for the older version of the order.
|
protected void | createShipChargeElementForHistory(org.w3c.dom.Element aParentElement, HistoryShipInfo historyShipChargeTCPolicyData)
This method creates the shipCharge element for the older version of the order.
|
protected void | createShipModeElementForHistory(org.w3c.dom.Element aParentElement, HistoryShipInfo historyShipChargesByShipMode)
Deprecated.
the ship mode element for history is created by createUsableShipChargesAndAccountByShipModeElementsForHistory. This is done by populating ShippingModeDescriptionDataBean for all unique items.
|
protected void | createShippingAdjustmentsElementsForHistory(OrderBaseSearchResultBean abnOrderBaseSearchResult, org.w3c.dom.Element aParentElement)
This method calls the getShippingAdjustmentDataBeans method on the ShippingAdjustmentDataBean which is constructed using the order Id obtained using the OrderDataBean passed in to obtain a list of shipping adjustments.
|
protected org.w3c.dom.Element | createShippingCarriersElementForHistory(org.w3c.dom.Element aParentElement, HistoryShipInfo bnHistoryShipCarrierAccount)
This method creates the ShippingCarriers element and its sub elements.
|
protected void | createShippingCarriersElementsForHistory(OrderBaseSearchResultBean abnOrderBaseSearchResult, org.w3c.dom.Element aParentElement)
This method obtains a list of shipping carrier accounts for the older version of the order.
|
protected org.w3c.dom.Element | createShippingInstructionsElementForHistory(org.w3c.dom.Element aParentElement, HistoryShipInfo bnHistoryShipInstruction)
This method creates ShippingInstructions element and its sub elements.
|
protected void | createShippingInstructionsElementsForHistory(OrderBaseSearchResultBean abnOrderBaseSearchResult, org.w3c.dom.Element aParentElement)
This method obtains a list of shipping instructions.
|
protected org.w3c.dom.Element | createStoreElementForHistory(OrderBaseSearchResultBean abnOrderBaseSearchResult, org.w3c.dom.Element aParentElement)
This method creates the Store element.
|
protected org.w3c.dom.Element | createSubLineElementForHistory(org.w3c.dom.Element aParentElement, HistoryOrderItem historyOrderItem)
This method builds the SubLine Element for the older version of the order.
|
protected org.w3c.dom.Element | createTaxElementForHistory(OrderBaseSearchResultBean abnOrderBaseSearchResult, org.w3c.dom.Element aParentElement)
This method builds the Tax element for an older version of the order.
|
protected org.w3c.dom.Element | createTieCodeElementForHistory(org.w3c.dom.Element aParentElement, HistoryOrderItem historyOrderItem)
This method builds the TieCode element for the given order item in the older version of the order..
|
protected org.w3c.dom.Element | createTransportationTermElementForHistory(org.w3c.dom.Element aParentElement, HistoryOrderItem historyOrderItem)
This method builds the TransportationTerm element for an order item in an older version of the order.
|
protected org.w3c.dom.Element | createUnitPriceElementForHistory(org.w3c.dom.Element aParentElement, HistoryOrderItem historyOrderItem)
This method builds the UnitPrice for an order item in an older version of the order.
|
protected void | createUsableShipChargesAndAccountByShipModeElementsForHistory(OrderBaseSearchResultBean abnOrderBaseSearchResult, org.w3c.dom.Element aParentElement)
This method obtains a list of available shipping modes for the older version of the order.
|
java.util.ArrayList | executeGetHistoryOrder(SearchCriteria aSearchCriteria, java.lang.String orderId)
This method gets the list of older order versions that meets the given search criteria.
|
java.util.ArrayList | executeGetSalesOrder(SearchCriteria aSearchCriteria)
This method gets the list of sales orders that meets the given search criteria.
|
OrderItemDataBean[] | executeGetSalesOrderItems(SearchCriteria aSearchCriteria)
This method gets the list of sales orders items that meets the given search criteria.
|
protected java.util.List | executeGetStoreIds(SearchCriteria aSearchCriteria)
This method returns the list of store IDs that should be used in the order search.
|
protected static AddressAccessBean[] | getAllowableBillingAddressesForHistory(HistoryOrder historyOrder)
This method gets an array of allowable billing addresses for an older version of the order.
|
protected java.lang.String | getHistoryOrderVersion(SearchCriteria aSearchCriteria)
This obtains the value corresponding to the historyOrderVersion select expression in the search criteria.
|
OrderBaseSearchResultBean | getOrderBaseSearchResultBean()
This method retrieves the current OrderSeachResultBean that carries the result, either Order or Quote.
|
protected boolean | getOrderItemsDetailsFlag(SearchCriteria aSearchCriteria)
This method returns the GetOrderItems search parameter.
|
protected boolean | getOrderLevelDetailsFlag(SearchCriteria aSearchCriteria)
This method returns the GetOrderLevelDetails search parameter.
|
java.lang.String | getResultSetSize()
This method gets the result set size of the search.
|
protected java.lang.String | getRootElementName()
This method gets the root element name of the response document.
|
protected SearchCriteria | getSearchCriteria(org.w3c.dom.Document aRequestBod)
This method gets the search criteria from the request Business Object Document.
|
protected boolean | getShippedItemsFlag(SearchCriteria aSearchCriteria)
This method obtains the value corresponding to the GetShippedItems select expression in the search criteria.
|
protected boolean | getShowHistoryOrderFlag(SearchCriteria aSearchCriteria)
This obtains the value corresponding to the showHistoryOrder select expression in the search criteria.
|
void | init(CommandContext aCmdCtxt, TypedProperty aRequestProperties, TypedProperty aResponseProperties, org.w3c.dom.Document aRequestBOD, org.w3c.dom.Document aResponseBOD)
This method initializes the necessary parameters before starting to build the response Business Object Document.
|
protected WhereClauseCondition | initializeOrderQuery(SearchCriteria aSearchCriteria)
This method initializes the search bean with the given search criteria.
|
void | setResultSetSize(java.lang.String resultSetSize)
This method sets the result set size of the search.
|
public static final java.lang.String CLASSNAME
public static final java.lang.String COPYRIGHT
public void init(CommandContext aCmdCtxt, TypedProperty aRequestProperties, TypedProperty aResponseProperties, org.w3c.dom.Document aRequestBOD, org.w3c.dom.Document aResponseBOD)
This method first calls the init method from the parent class.
It will then call the initializeSearchTypeMapping to initialize the mappings between the search types obtained from the SelectExpression element in the request Business Object Document to the actual value set to the search bean.
Initialize the constant DEFAULT_SEARCH_TYPE_VALUE to contain the value of BodConstants.VAL_EXACT_MATCH. This indicates that the default value of search types is exact match.
protected void buildDataArea() throws ECException
This method calls the method getSearchCriteria to obtain the search criteria from the request Business Object Document. After that 1. if showHistoryOrder is true the method buildDataAreaForHistoryOrder will create the SalesOrder element for a history order. 2. Request coming from an old client where feature pack 2 is not applied, that is both the flags are false. In this case buildDataAreaForSalesOrder will be invoked. If the getOrderItemsDetails has a value true the Line elements would not be constructed. 3. Only order items are requested. In this case buildDataAreaForSalesOrderItems is invoked.
protected void buildDataAreaForSalesOrder(SearchCriteria searchCriteria) throws ECException
This method calls the executeGetSalesOrder to get the list of sales orders which meet the given search criteria. For each sales order found in the search result, this method will call method createSalesOrderElement to build the SalesOrder element.
The BOD constructed would look like:<wc:DataArea> <wc:Show confirm="Always" numSearchResults="1" resultSetSize="1" pageSizeExceeded="true" /> <wc:SalesOrder> <wc:Header> <oa:DocumentIds> <!-- Document Id information --> </oa:DocumentIds> <oa:OrderStatus> <!-- Order status information --> </oa:OrderStatus> <wc:IsEmpty>false</wc:IsEmpty> <wc:NextAvailableTieCode>1</wc:NextAvailableTieCode> <oa:ExtendedPrice currency="USD">107.00000</oa:ExtendedPrice> <oa:TotalAmount currency="USD">99.88000</oa:TotalAmount> <wc:PaymentTerms> <!-- Payment terms infomation --></wc:PaymentTerms> <oa:Charges> <oa:TransportationCharge> <oa:Total currency="USD">10.00000</oa:Total> </oa:TransportationCharge> </oa:Charges> <oa:Parties> <!-- Customer party & bill to party information --> </oa:Parties> <oa:Tax> <!-- Tax information --> </oa:Tax> <oa:LastModificationDateTime>2007-01-20 11:25:06.39</oa:LastModificationDateTime> <wc:ShipAsComplete>Y</wc:ShipAsComplete> <wc:OrderPlacedDate>2007-01-18 14:04:42.125</wc:OrderPlacedDate> <wc:PONumberRequired>false</wc:PONumberRequired> <wc:Store> <!-- Store information --> </wc:Store> <wc:IsPreparedInd>true</wc:IsPreparedInd> <wc:CurrentOrderEditorId/> <wc:BusinessChannel> <!-- Bussiness channel information --> </wc:BusinessChannel> <wc:OrderCurrentCharges> <!-- Current order charges --> </wc:OrderCurrentCharges> <wc:OrderUnpaidBalance currency="USD">0.00000</wc:OrderUnpaidBalance> <wc:OrderPromotionCodes/> </wc:Header> <wc:Line> <!-- Line information --> </wc:Line> <!-- More lines --> <wc:OrderShippingInformation> <!-- Order shipping information --> </wc:OrderShippingInformation> <wc:OrderHistoryExistedFlag>true</wc:OrderHistoryExistedFlag> <wc:OrderVersion>7</wc:OrderVersion> <wc:UserData/> </wc:SalesOrder> </wc:DataArea>if the getOrderItemsDetails is false the Line elements would not be constructed.
protected void buildDataAreaForSalesOrderItems(SearchCriteria searchCriteria) throws ECException
This method calls the method getSearchCriteria to obtain the search criteria from the request Business Object Document. If we then call the method executeGetSalesOrderItems to get the list of sales order items which meet the given search criteria. For each sales order items found in the search result, this method will call method createLineDetailElement to build the Line element. The BOD constructed would look like:
<wc:DataArea> <wc:Show confirm="Always" numSearchResults="4" resultSetSize="4"/> <wc:SalesOrder> <wc:Line> <oa:LineNumber>55001</oa:LineNumber> <!-- Order status information --> <oa:OrderItem> <!-- Order item information --> </oa:OrderItem> <oa:OrderQuantity uom="NMTOKEN">1</oa:OrderQuantity> <oa:UnitPrice> <oa:Amount currency="USD">26.75000</oa:Amount> <oa:PerQuantity uom="each">1</oa:PerQuantity> </oa:UnitPrice> <oa:ExtendedPrice currency="USD">26.75000</oa:ExtendedPrice> <wc:ExpediteOrderItem>N</wc:ExpediteOrderItem> <oa:Parties> <!-- Customer party & ShipToParty Information --> </oa:Parties> <oa:TransportationTerm> <!-- Term code --></oa:TransportationTerm> <oa:Charges> <!-- Miscellaneous Charge information --> </oa:Charges> <wc:PaymentTerms> <!-- Discount amount --> </wc:PaymentTerms> <oa:DocumentReferences> <!-- Contract information --> </oa:DocumentReferences> <wc:AllocatedQuantity uom="NMTOKEN">1</wc:AllocatedQuantity> <wc:TieCode> <!-- Tie code information --> </wc:TieCode> <wc:ItemCreateDate>2007-01-18 15:23:12.656</wc:ItemCreateDate> <wc:AvailShippingModes> <!-- Shipping mode information --></wc:AvailShippingModes> <oa:ElectronicCatalog> <!-- Electronic catalog information --> </oa:ElectronicCatalog> <oa:Shipped> <oa:Code>NO</oa:Code> </oa:Shipped> <wc:SubLine> <!-- Subline information --> </wc:SubLine> </wc:Line> <!-- More line information--> </wc:SalesOrder> </wc:Show> </wc:DataArea>
protected void buildDataAreaForHistoryOrder(SearchCriteria searchCriteria) throws ECException
<wc:DataArea> <wc:Show confirm="Always" numSearchResults="1" resultSetSize="1"/> <wc:SalesOrder> <wc:Header> <oa:DocumentIds> <!-- Document Id information --> </oa:DocumentIds> <oa:OrderStatus> <!-- Order status information --> </oa:OrderStatus> <wc:IsEmpty>false</wc:IsEmpty> <wc:NextAvailableTieCode>1</wc:NextAvailableTieCode> <oa:ExtendedPrice currency="USD">107.00000</oa:ExtendedPrice> <oa:TotalAmount currency="USD">99.88000</oa:TotalAmount> <wc:PaymentTerms> <!-- Payment terms infomation --></wc:PaymentTerms> <oa:Charges> <oa:TransportationCharge> <oa:Total currency="USD">10.00000</oa:Total> </oa:TransportationCharge> </oa:Charges> <oa:Parties> <!-- Customer party & bill to party information --> </oa:Parties> <oa:Tax> <!-- Tax information --> </oa:Tax> <oa:LastModificationDateTime>2007-01-20 11:25:06.39</oa:LastModificationDateTime> <wc:ShipAsComplete>Y</wc:ShipAsComplete> <wc:OrderPlacedDate>2007-01-18 14:04:42.125</wc:OrderPlacedDate> <wc:PONumberRequired>false</wc:PONumberRequired> <wc:Store> <!-- Store information --> </wc:Store> <wc:IsPreparedInd>true</wc:IsPreparedInd> <wc:CurrentOrderEditorId/> <wc:BusinessChannel> <!-- Bussiness channel information --> </wc:BusinessChannel> <wc:OrderCurrentCharges> <!-- Current order charges --> </wc:OrderCurrentCharges> <wc:OrderUnpaidBalance currency="USD">0.00000</wc:OrderUnpaidBalance> <wc:OrderPromotionCodes/> </wc:Header> <wc:Line> <!-- Line information --> </wc:Line> <!-- More lines --> <wc:OrderShippingInformation> <!-- Order shipping information --> </wc:OrderShippingInformation> <wc:OrderHistoryExistedFlag>true</wc:OrderHistoryExistedFlag> <wc:OrderVersion>7</wc:OrderVersion> <wc:UserData/> </wc:SalesOrder> </wc:DataArea>if the getOrderItemsDetails is false the Line elements would not be constructed. If the getOrderItemsDetails is true only the Line elements are created. The BOD constructed would look like:
<wc:DataArea> <wc:Show confirm="Always" numSearchResults="4" resultSetSize="4"/> <wc:SalesOrder> <wc:Line> <oa:LineNumber>55001</oa:LineNumber> <!-- Order status information --> <oa:OrderItem> <!-- Order item information --> </oa:OrderItem> <oa:OrderQuantity uom="NMTOKEN">1</oa:OrderQuantity> <oa:UnitPrice> <oa:Amount currency="USD">26.75000</oa:Amount> <oa:PerQuantity uom="each">1</oa:PerQuantity> </oa:UnitPrice> <oa:ExtendedPrice currency="USD">26.75000</oa:ExtendedPrice> <wc:ExpediteOrderItem>N</wc:ExpediteOrderItem> <oa:Parties> <!-- Customer party & ShipToParty Information --> </oa:Parties> <oa:TransportationTerm> <!-- Term code --></oa:TransportationTerm> <oa:Charges> <!-- Miscellaneous Charge information --> </oa:Charges> <wc:PaymentTerms> <!-- Discount amount --> </wc:PaymentTerms> <oa:DocumentReferences> <!-- Contract information --> </oa:DocumentReferences> <wc:AllocatedQuantity uom="NMTOKEN">1</wc:AllocatedQuantity> <wc:TieCode> <!-- Tie code information --> </wc:TieCode> <wc:ItemCreateDate>2007-01-18 15:23:12.656</wc:ItemCreateDate> <wc:AvailShippingModes> <!-- Shipping mode information --></wc:AvailShippingModes> <oa:ElectronicCatalog> <!-- Electronic catalog information --> </oa:ElectronicCatalog> <oa:Shipped> <oa:Code>NO</oa:Code> </oa:Shipped> <wc:SubLine> <!-- Subline information --> </wc:SubLine> </wc:Line> <!-- More line information--> </wc:SalesOrder> </wc:Show> </wc:DataArea>
public OrderItemDataBean[] executeGetSalesOrderItems(SearchCriteria aSearchCriteria) throws ECException
public java.util.ArrayList executeGetSalesOrder(SearchCriteria aSearchCriteria) throws ECException
protected java.util.List executeGetStoreIds(SearchCriteria aSearchCriteria) throws ECException
protected boolean getShippedItemsFlag(SearchCriteria aSearchCriteria)
protected boolean getShowHistoryOrderFlag(SearchCriteria aSearchCriteria)
protected java.lang.String getHistoryOrderVersion(SearchCriteria aSearchCriteria)
protected WhereClauseCondition initializeOrderQuery(SearchCriteria aSearchCriteria)
protected SearchCriteria getSearchCriteria(org.w3c.dom.Document aRequestBod)
This method will first call the getSearchCriteria of the parent class. It will then add a select expression with fieldName= BodConstants.VAL_ORDER_TYPE, fieldValue= OrderConstants.ORDER_TYPE_ORDER and searchType= BodConstants.KEY_EXACT_MATCH to the search criteria.
protected java.lang.String getRootElementName()
public java.lang.String getResultSetSize()
public void setResultSetSize(java.lang.String resultSetSize)
protected org.w3c.dom.Element createSalesOrderElementForHistory(org.w3c.dom.Element aParent, OrderBaseSearchResultBean orderSearchResultBean) throws ECException
protected org.w3c.dom.Element buildNounElementForHistory(org.w3c.dom.Element aParent, java.lang.String astrNounTagName, OrderBaseSearchResultBean orderSearchResultBean) throws ECException
protected org.w3c.dom.Element buildNounElementDetailInfoForHistory(org.w3c.dom.Element aParentElement, OrderBaseSearchResultBean orderSearchResultBean) throws ECException
This method calls the following methods to create the child elements of this noun:
<wc:Header> . <!-- Created by createHeaderElementForHistory method --> <wc:Header> <wc:Line> . <!-- Created by createLineElementForHistory method --> <wc:Line> <wc:OrderShippingInformation> . <!-- Created by createOrderShippingInformationElementForHistory method --> <wc:OrderShippingInformation>
protected org.w3c.dom.Element createOrderShippingInformationElementForHistory(org.w3c.dom.Element aParentElement, OrderBaseSearchResultBean abnOrderBaseSearchResult) throws ECException
protected void createUsableShipChargesAndAccountByShipModeElementsForHistory(OrderBaseSearchResultBean abnOrderBaseSearchResult, org.w3c.dom.Element aParentElement) throws ECException
protected void createShipModeElementForHistory(org.w3c.dom.Element aParentElement, HistoryShipInfo historyShipChargesByShipMode) throws ECException
protected void createShipChargeElementForHistory(org.w3c.dom.Element aParentElement, HistoryShipInfo historyShipChargeTCPolicyData) throws ECException
protected void createShippingCarriersElementsForHistory(OrderBaseSearchResultBean abnOrderBaseSearchResult, org.w3c.dom.Element aParentElement) throws ECException
protected org.w3c.dom.Element createShippingCarriersElementForHistory(org.w3c.dom.Element aParentElement, HistoryShipInfo bnHistoryShipCarrierAccount) throws ECException
protected void createShippingInstructionsElementsForHistory(OrderBaseSearchResultBean abnOrderBaseSearchResult, org.w3c.dom.Element aParentElement) throws ECException
protected org.w3c.dom.Element createShippingInstructionsElementForHistory(org.w3c.dom.Element aParentElement, HistoryShipInfo bnHistoryShipInstruction) throws ECException
protected void createShippingAdjustmentsElementsForHistory(OrderBaseSearchResultBean abnOrderBaseSearchResult, org.w3c.dom.Element aParentElement) throws ECException
protected org.w3c.dom.Element createLineElementForHistory(org.w3c.dom.Element aParentElement, OrderBaseSearchResultBean abnOrderBaseSearchResult) throws ECException
<wc:Line> <oa:LineNumber>20002</oa:LineNumber> <oa:OrderStatus> ... </oa:OrderStatus> <oa:OrderItem> ... </oa:OrderItem> <oa:OrderQuantity uom="NMTOKEN">2</oa:OrderQuantity> <oa:UnitPrice> ... </oa:UnitPrice> <oa:ExtendedPrice currency="USD">319.98000</oa:ExtendedPrice> <wc:ExpediteOrderItem>N</wc:ExpediteOrderItem> <oa:Parties> ... </oa:Parties> <oa:TransportationTerm> ... </oa:TransportationTerm> <oa:Charges /> <wc:PaymentTerms> ... </wc:PaymentTerms> <oa:DocumentReferences> ... </oa:DocumentReferences> <wc:AllocatedQuantity uom="NMTOKEN">2</wc:AllocatedQuantity> <wc:TieCode /> <wc:ItemCreateDate>20060512 19:05:47.094</wc:ItemCreateDate> <wc:AvailShippingModes> ... </wc:AvailShippingModes> <oa:ElectronicCatalog> ... </oa:ElectronicCatalog> <oa:Shipped> ... </oa:Shipped> <wc:SubLine> ... </wc:SubLine> </wc:Line>
protected org.w3c.dom.Element createSubLineElementForHistory(org.w3c.dom.Element aParentElement, HistoryOrderItem historyOrderItem) throws ECException
This method calls the createExtendedPriceElement method to build the ExtendedPrice element.
This method calls the createAllocQuantityElement method to build the AllocQuantity element.
<SubLine> <oa:LineNumber>75001</oa:LineNumber> <oa:OrderItem> <oa:ItemStatus> <oa:Code>ALLC</oa:Code> </oa:ItemStatus> </oa:OrderItem> <oa:OrderQuantity uom="NMTOKEN">1</oa:OrderQuantity> <oa:ExtendedPrice currency="USD">259.00</oa:ExtendedPrice> <!-- created by the createExtendedPriceElement method --> <oa:EarliestShipDate>2004-11-12</oa:EarliestShipDate> <DistributionCenter>11201</DistributionCenter> <AllocatedQuantity uom="NMTOKEN">1</AllocatedQuantity> <!-- created by the createAllocQuantityElement method --> </SubLine>
protected org.w3c.dom.Element createItemShippedElementForHistory(org.w3c.dom.Element aParentElement) throws ECException
This method creates the child element CODE. If the order item is shipped, the CODE will have value 'YES'. Otherwise, the value is 'NO'.
protected org.w3c.dom.Element createElectronicCatalogElementForHistory(org.w3c.dom.Element aParentElement, HistoryOrderItem historyOrderItem, OrderBaseSearchResultBean obsrb) throws ECException
Otherwise this method will build the ElectronicCatalog element.
protected org.w3c.dom.Element createAvailableShippingModesElementForHistory(org.w3c.dom.Element aParentElement) throws ECException
protected org.w3c.dom.Element createAvailableShippingModesElementForHistory(org.w3c.dom.Element aParentElement, HistoryOrderItem item) throws ECException
protected org.w3c.dom.Element createTieCodeElementForHistory(org.w3c.dom.Element aParentElement, HistoryOrderItem historyOrderItem) throws ECException
protected org.w3c.dom.Element createContractIDElementForHistory(org.w3c.dom.Element aParentElement, HistoryOrderItem historyOrderItem) throws ECException
The following is a sample DocumentReferences element that indicates how the element is constructed:
<oa:DocumentReferences> <oa:ContractDocumentReference> <oa:DocumentIds> <oa:DocumentId> <oa:Id>12501</oa:Id> </oa:DocumentId> </oa:DocumentIds> </oa:ContractDocumentReference> </oa:DocumentReferences>
protected org.w3c.dom.Element createPaymentTermsElementForHistory(org.w3c.dom.Element aParentElement, HistoryOrderItem historyOrderItem) throws ECException
protected org.w3c.dom.Element createChargesElementForHistory(org.w3c.dom.Element aParentElement) throws ECException
protected org.w3c.dom.Element createTransportationTermElementForHistory(org.w3c.dom.Element aParentElement, HistoryOrderItem historyOrderItem) throws ECException
protected org.w3c.dom.Element createPartiesElementForHistory(org.w3c.dom.Element aParentElement, HistoryOrderItem historyOrderItem) throws ECException
The following is a sample Parties element that indicates how the element is constructed:
<oa:Parties> <oa:CustomerParty> <oa:Addresses> <Address> <AddressId>1000<AddressId> </Address> </oa:Addresses> </oa:CustomerParty> <oa:ShipToParty> <oa:Addresses> <Address> <AddressId>1000<AddressId> </Address> <Address> <AddressId>1001<AddressId> </Address> </oa:Addresses> &/lt;oa:ShipToParty> </oa:Parties>
protected org.w3c.dom.Element createIsExpediteElementForHistory(org.w3c.dom.Element aParentElement, HistoryOrderItem historyOrderItem) throws ECException
protected org.w3c.dom.Element createNeedToDeliveryDateElementForHistory(org.w3c.dom.Element aParentElement, HistoryOrderItem historyOrderItem) throws ECException
protected org.w3c.dom.Element createUnitPriceElementForHistory(org.w3c.dom.Element aParentElement, HistoryOrderItem historyOrderItem) throws ECException
The following is a sample UnitPrice element that shows how the element is constructed:
<oa:UnitPrice> <oa:Amount currency="USD">259.00</oa:Amount> <oa:PerQuantity uom="each">1</oa:PerQuantity> </oa:UnitPrice>
protected org.w3c.dom.Element createOrderItemElementForHistory(org.w3c.dom.Element aParentElement, HistoryOrderItem bnHistoryOrderItem) throws ECException
The following is a sample OrderItem element that shows how the element is constructed:
<oa:OrderItem> <oa:ItemIds> <oa:ItemId> <oa:Id>10904</oa:Id>> </oa:ItemId> <oa:SupplierItemId> <oa:Id>HWARE_1040</oa:Id> <oa:AssigningPartyId> <oa:Id>7000000000000000601</oa:Id> </oa:AssigningPartyId> </oa:SupplierItemId> <oa:SupplierItemId> <oa:Id></oa:Id> <oa:AssigningPartyId> <oa:Id>CONFIGURATOR</oa:Id> </oa:AssigningPartyId> </oa:SupplierItemId> </oa:ItemIds> </oa:OrderItem>
protected org.w3c.dom.Element createOrderItemStatusElementForHistory(org.w3c.dom.Element aParentElement) throws ECException
This method creates the child element CODE. If the order item is editable, the CODE will have value 'YES'. Otherwise, the value is 'NO'.
protected org.w3c.dom.Element createHeaderElementForHistory(org.w3c.dom.Element aParentElement, OrderBaseSearchResultBean orderSearchResultBean) throws ECException
This method calls the following methods to create the child elements of the Header element:
This method also creates the following child elements:
<wc:Header> <oa:DocumentIds> ... <!-- Created by createDocumentIdsElement method --> </oa:DocumentIds> <oa:OrderStatus> ... <!-- Created by createOrderStatusElementForHistory method --> </oa:OrderStatus> <oa:ExtendedPrice currency="USD">319.98000</oa:ExtendedPrice> <oa:TotalAmount currency="USD">335.98000</oa:TotalAmount> <wc:PaymentTerms> ... <!-- Created by createPaymentTermsElementForHistory method --> </wc:PaymentTerms> <oa:Charges> . <!-- Created by createChargesElementForHistory method --> </oa:Charges> <oa:Parties> ... <!-- Created by createPartiesElementForHistory method --> </oa:Parties> <oa:Tax> ... <!-- Created by createTaxElementForHistory method --> </oa:Tax> <oa:LastModificationDateTime>20060515 17:11:06.484</oa:LastModificationDateTime> <wc:ShipAsComplete>Y</wc:ShipAsComplete> <wc:OrderPlacedDate>20060512 19:08:44.139</wc:OrderPlacedDate> <wc:PONumberRequired>true</wc:PONumberRequired> <wc:PONumber>1</wc:PONumber> <wc:Store> ... <!-- Created by createStoreElement method --> </wc:Store> <wc:IsPreparedInd>true</wc:IsPreparedInd> <wc:CurrentOrderEditorId /> <wc:BusinessChannel> ... <!-- Created by createBusinessChannelElement method --> </wc:BusinessChannel> <wc:OrderCurrentCharges> ... <!-- Created by createOrderCurrentChargesElementForHistory method --> </wc:OrderCurrentCharges> <wc:OrderUnpaidBalance currency="USD">0.00000</wc:OrderUnpaidBalance> <wc:OrderBlocks> ... <!-- Created by createOrderBlocksElementForHistory method --> </wc:OrderBlocks> </wc:Header>
protected org.w3c.dom.Element createOrderBlocksElementForHistory(OrderBaseSearchResultBean abnSearchResult, org.w3c.dom.Element aParentElement) throws ECException
This method calls the createOrderBlockElement to create the OrderBlock element.
protected org.w3c.dom.Element createOrderBlockElementForHistory(org.w3c.dom.Element aParentElement, HistoryOrderBlock abnOrderBlock) throws ECException
The following child elements will be built:
<wc:OrderBlock> <wc:BlockId>11001</wc:BlockId> <wc:BlockReasonCodeId>5010</wc:BlockReasonCodeId> <wc:BlockReasonCodeDesc>Buyer fraud suspected</wc:BlockReasonCodeDesc> <wc:Description>xsxas</wc:Description> <wc:BlockedInd>true</wc:BlockedInd> <wc:BlockDate>2006-05-15 17:21:06.276</wc:BlockDate> <wc:ManualBlockInd>true</wc:ManualBlockInd> </wc:OrderBlock>
protected org.w3c.dom.Element createChargesElementForHistory(org.w3c.dom.Element aParentElement, OrderBaseSearchResultBean orderSearchResultBean) throws ECException
This methods calls createTransportationChargeElement to build the TransportationCharge Element.
This methods calls the createMiscellaneousChargeElement to build the MiscellaneousCharge element for order level surcharge adjustments and order level discount adjustments.
protected org.w3c.dom.Element createPaymentTermsElementForHistory(HistoryOrder historyOrder, org.w3c.dom.Element aParentElement) throws ECException
This method calls createDiscountAmountElement to create the DiscountAmount element. The value of this element contains the discount amount for the entire order.
This method calls createAvailablePaymentMethodsElement to create the AvailablePaymentMethods element. The value of this element contains the list of available payments.
protected org.w3c.dom.Element createAvailablePaymentMethodsElementForHistory(HistoryOrder historyOrder, org.w3c.dom.Element aParentElement) throws ECException
The following is a sample AvailablePaymentMethods element that indicates how the element is constructed:
<AvailablePaymentMethods> <PaymentMethods> <PaymentMethodId>PayLater</PaymentMethodId> <Description>Pay later</Description> </PaymentMethods> <PaymentMethods> <PaymentMethodId>VISA</PaymentMethodId> <Description>VISA Credit Card</Description> </PaymentMethods> </AvailablePaymentMethods>
protected org.w3c.dom.Element createAddressesElementForHistory(HistoryOrder historyOrder, java.lang.String paymentTCId, org.w3c.dom.Element aParentElement) throws ECException
This method will create an Address element for each address billing address available for this order. Each Address element is created with only the AddressId child element.
protected static AddressAccessBean[] getAllowableBillingAddressesForHistory(HistoryOrder historyOrder) throws ECException
protected org.w3c.dom.Element createOrderStatusElementForHistory(HistoryOrder historyOrder, org.w3c.dom.Element aParentElement) throws ECException
This method creates the child element Code. The value of this method indicates the order status.
This method calls the method createAcknowledgementDetailElement to create AcknowledgementDetail element and createOrderEditableElement to create UserArea.
protected org.w3c.dom.Element createAcknowledgementDetailElementForHistory(org.w3c.dom.Element aParentElement) throws ECSystemException
This method creates the child element Code. This implementation sets the value to NO.
protected org.w3c.dom.Element createOrderEditableElementForHistory(org.w3c.dom.Element aParentElement) throws ECSystemException, ECException
This method creates the following child elements of the user area.
public java.util.ArrayList executeGetHistoryOrder(SearchCriteria aSearchCriteria, java.lang.String orderId) throws ECException
protected org.w3c.dom.Element createOrderCurrentChargesElementForHistory(OrderBaseSearchResultBean abnSearchResult, org.w3c.dom.Element aParentElement) throws ECException
protected org.w3c.dom.Element createHistoryExtendedPriceElementForHistory(org.w3c.dom.Element aParentElement, java.lang.String astrPrice, java.lang.String astrCurrency) throws ECException
protected org.w3c.dom.Element createOrderUnpaidBalanceElementForHistory(OrderBaseSearchResultBean abnSearchResult, org.w3c.dom.Element aParentElement) throws ECException
protected org.w3c.dom.Element createPartiesElementForHistory(OrderBaseSearchResultBean abnOrderBaseSearchResult, org.w3c.dom.Element aParentElement) throws ECException
This methods calls the method createCustomerPartyElement to create the CustomerParty element.
This methods calls the method createBillToPartyElement to create the BillToParty element.
protected org.w3c.dom.Element createBillToPartyElementForHistory(OrderBaseSearchResultBean abnOrderBaseSearchResult, org.w3c.dom.Element aParentElement) throws ECException
This method calls the createPartyIdElement to create the PartyId element. This element contains the billing address id.
This method calls the createPaymentInstructionElement to create the PaymentInstruction element.
This method creates the child element 'Currency'.
protected org.w3c.dom.Element createPaymentInstructionElementForHistory(java.util.HashMap ahashProtocolData, EDPPaymentInstruction aPiData, org.w3c.dom.Element aParentElement) throws ECException
The following is a sample PaymentInstruction element that shows how the element is constructed:
<PaymentInstruction> <PIId>13501</PIId> <PIAmount>638.40000</PIAmount> <PIMethod>BillMeLater</PIMethod> <PIDataEditable>true</PIDataEditable> <PIAmountEditable>true</PIAmountEditable> <PIValid>true</PIValid> <UserDataField name="langId">-1</UserDataField> <UserDataField name="@revision">8.1.0</UserDataField> <UserDataField name="ReUrl">NoReURL</UserDataField> </PaymentInstruction>
protected org.w3c.dom.Element createCustomerPartyElementForHistory(OrderBaseSearchResultBean abnOrderBaseSearchResult, org.w3c.dom.Element aParentElement) throws ECException
<CustomerParty> <PartyId> <Id>100</Id> </PartyId> </CustomerParty>
protected org.w3c.dom.Element createTaxElementForHistory(OrderBaseSearchResultBean abnOrderBaseSearchResult, org.w3c.dom.Element aParentElement) throws ECException
The following is a sample Tax element that indicates how the element is constructed:
<oa:Tax> <oa:TaxAmount currency="USD">30.40000</oa:TaxAmount> <oa:Charges> <oa:TransportationCharge> <!-- created by the createTransportationChargeElement method --> . . </oa:TransportationCharge> </oa:Charges> </oa:Tax>
public OrderBaseSearchResultBean getOrderBaseSearchResultBean()
protected boolean getOrderLevelDetailsFlag(SearchCriteria aSearchCriteria)
protected boolean getOrderItemsDetailsFlag(SearchCriteria aSearchCriteria)
protected org.w3c.dom.Element createStoreElementForHistory(OrderBaseSearchResultBean abnOrderBaseSearchResult, org.w3c.dom.Element aParentElement) throws ECException
The following child elements will be built:
<wc:Store> <wc:StoreId>10001</wc:StoreId> <wc:Description>AdvancedB2BDirect</wc:Description> <wc:Type>B2B</wc:Type> </wc:Store>
protected org.w3c.dom.Element createBusinessChannelElementForHistory(OrderBaseSearchResultBean abnSearchResult, org.w3c.dom.Element aParentElement) throws ECException
protected org.w3c.dom.Element createQuoteExpiryPeriodElementForHistory(OrderBaseSearchResultBean abnOrderBaseSearchResult, org.w3c.dom.Element headerElement) throws ECException
The following is a sample ExpirePeriod element that indicates how the element is constructed:
<wc:ExpirePeriod>172800</wc:ExpirePeriod>
protected void createQuoteExpireDateElementForHistory(OrderBaseSearchResultBean abnOrderBaseSearchResult, org.w3c.dom.Element headerElement) throws ECException
The following is a sample ExpireDate element that indicates how the element is constructed:
<wc:ExpireDate>172800/wc:ExpireDate>