Field Detail

• CLASSNAME

  public static final java.lang.String CLASSNAME
  

  Class name field.

  See Also:

  Constant Field Values

• COPYRIGHT

  public static final java.lang.String COPYRIGHT
  

  IBM Copyright notice field.

  See Also:

  Constant Field Values

• getShippedItemsOnly

  protected boolean getShippedItemsOnly
  

  Flag for searching only for shipped order items. This is initialized to false.

Constructor Detail

• OrderBase

  public OrderBase()
  

  Default constructor.

Method Detail

• getCustomerSearchCriteria

  protected SearchCriteria getCustomerSearchCriteria(OrderBaseSearchResultBean abnOrderBaseSearchResult)
                                              throws ECException
  

  This method gets the search criteria which will be used to search the owner of the specified order. This implementation returns the member id contained in the OrderDataBean as the search criteria.

  Parameters:

  abnOrderBaseSearchResult - The information of the order which the customer owns.

  Returns:

  The search criteria to be used to search the owner of the order.

  Throws:

  ECException

• getEditorLogonId

  protected java.lang.String getEditorLogonId(OrderBaseSearchResultBean abnOrderBaseSearchResult)
                                       throws ECException
  

  This method gets the order editor's logon ID.

  Parameters:

  abnOrderBaseSearchResult - The order details.

  Returns:

  The editor's logon ID

  Throws:

  ECException

• populateSearchResult

  protected OrderBaseSearchResultBean populateSearchResult(OrderDataBean abnOrderDataBean,
                                               OrderBaseSearchResultBean abnSearchResult,
                                               boolean aboolGetOrderDetails)
                                                    throws ECException
  

  This method populates the search result bean OrderBaseSearchResultBean with the details of the order in the OrderDataBean bean. This method populates the following into OrderBaseSearchResultBean:

  • The order information from OrderDataBean,
  • The payment instruction information from EDPPaymentInstructionsDataBean,
  • The block information of Order from OrderBlockDataBean
  • The OrderComment information from OrderCommentDataBean
  • The order currency and
  • The order total amount computed by adding the product total of all the order items.

  This method also sets a boolean flag in OrderBaseSearchResultBean bean. If it is true, then bean will retrieve the order details and promotions (or merchandising association) related information.

  Parameters:

  abnOrderDataBean - The databean which contain the order information.

  abnSearchResult - The search result needs to be populated.

  aboolGetOrderDetails - A flag to indicate that if there is a need to get the order details and promotions information (or merchandising association information).

  Returns:

  The populated search result.

  Throws:

  ECException

• createAcknowledgementDetailElement

  protected org.w3c.dom.Element createAcknowledgementDetailElement(OrderBaseSearchResultBean abnOrderBaseSearchResult,
                                                       org.w3c.dom.Element aParentElement)
                                                            throws ECSystemException
  

  This method creates the AcknowledgementDetail element.

  This method creates the child element Code whose value contains the order editable status obtained from OrderDataBean.isEditable().

   <oa:AcknowledgementDetail>
                  <oa:Code>YES</oa:Code>
   </oa:AcknowledgementDetail>
   
  

  Parameters:

  abnOrderBaseSearchResult - The bean which contains the order information.

  aParentElement - The parent which the AcknowledgementDetail element will build on.

  Returns:

  The AcknowledgementDetail element created.

  Throws:

  ECSystemException

• createOrderEditableElement

  protected org.w3c.dom.Element createOrderEditableElement(OrderBaseSearchResultBean abnOrderBaseSearchResult,
                                               org.w3c.dom.Element aParentElement)
                                                    throws ECSystemException,
                                                           ECException
  

  This method creates the UserArea element inside the oa:OrderStatus element.

  This method creates the following child elements of the user area.

  • wc:isOrderEditable the value of this element can be used to identify if the order is editable or not. The value is YES if the order is editable, NO otherwise
  • .
  • wc:isOrderApprovalPEnding the value of this element can be used to identify if the order is waiting for approval by the buyer approver. The value is YES if the order is pending approval, NO otherwise
  • .
  • wc:isOrderLocked the value of this element can be used to identify if the order is locked or not. The value is YES if the order is locked by someone other than the current editor, NO if the order is locked by the current editor or un-locked
  • .
  • wc:checkLock the value of this element can be used to identify if the order is locked by the current editor. The value is YES if the order is locked by the current editor, NO otherwise
  • .

     <oa:UserArea>
                    <wc:isOrderEditable>YES</wc:isOrderEditable>
                    <wc:isOrderApprovalPending>NO</wc:isOrderApprovalPending>
                    <wc:isOrderLocked>NO</wc:isOrderLocked>
                    <wc:checkLock>NO</wc:checkLock>
     </oa:UserArea>
     
    

  Parameters:

  abnOrderBaseSearchResult - The bean which contains the order information.

  aParentElement - The parent which the UserArea element will build on.

  Returns:

  The UserArea element created.

  Throws:

  ECSystemException

  ECException

• isPickupInStoreShippingMode

  public boolean isPickupInStoreShippingMode(OrderDataBean bnOrderDataBean)
                                      throws ECSystemException
  

  This method verifies the PickupInStore shipping code for an order

  Parameters:

  bnOrderDataBean - orderItems of this orderDataBean are checked for PickupInStore shipping code, if any order item has PickupInStore shipping code, pickupInStoreValue is set to "YES".

  Returns:

  true if shipping code of an order item is PickupInStore, or false.

  Throws:

  ECSystemException

• createOrderStatusElement

  protected org.w3c.dom.Element createOrderStatusElement(OrderBaseSearchResultBean abnOrderBaseSearchResult,
                                             org.w3c.dom.Element aParentElement)
                                                  throws ECException
  

  This method creates the OrderStatus element.

  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.

   <oa:OrderStatus>
                  <oa:Code>M</oa:Code>
                  <oa:UserArea>
                  .                                       <!-- Created by createOrderEditableElement method -->
                  </oa:UserArea>
                  <oa:AcknowledgementDetail>
                  .                                       <!-- Created by createAcknowledgementDetailElement method -->
                  </oa:AcknowledgementDetail>
   </oa:OrderStatus>
   
  

  Parameters:

  abnOrderBaseSearchResult - The bean which contains the order information.

  aParentElement - The parent which the OrderStatus element will build on.

  Returns:

  The OrderStatus element.

  Throws:

  ECException

  See Also:

  createOrderEditableElement(OrderBaseSearchResultBean, Element), createAcknowledgementDetailElement(OrderBaseSearchResultBean, Element)

• createAvailablePaymentMethodsElement

  protected org.w3c.dom.Element createAvailablePaymentMethodsElement(OrderBaseSearchResultBean abnOrderBaseSearchResult,
                                                         org.w3c.dom.Element aParentElement)
                                                              throws ECException
  

  This method creates the AvailablePaymentMethods element. This method retrieves all the available payment methods and the attributes of the payment methods from the UsablePaymentTCListDataBean using the following method getFilteredPaymentTCInfo.

  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>
  
  
   
  

  Parameters:

  abnOrderBaseSearchResult - The bean which contains the order information.

  aParentElement - The parent which the AvailablePaymentMethods element will build on.

  Returns:

  The AvailablePaymentMethods element.

  Throws:

  ECException

  See Also:

  createUserDataInPaymentMethodsElement(PaymentTCInfo, OrderBaseSearchResultBean, Element)

• createPaymentTermsElement

  protected org.w3c.dom.Element createPaymentTermsElement(OrderBaseSearchResultBean abnOrderBaseSearchResult,
                                              org.w3c.dom.Element aParentElement)
                                                   throws ECException
  

  This method creates the PaymentTerms element for an order.

  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.

   <wc:PaymentTerms>
                  <oa:DiscountAmount currency="USD">0.00000 </oa:DiscountAmount>
                  <wc:AvailablePaymentMethods>
                  .                               <!-- Created by createAvailablePaymentMethodsElement method -->
                  </wc:AvailablePaymentMethods>
   </wc:PaymentTerms>
   
  

  Parameters:

  abnOrderBaseSearchResult - The bean which contains the order information.

  aParentElement - The parent which the PaymentTerms element will build on.

  Returns:

  The PaymentTerms element.

  Throws:

  ECException

  See Also:

  createDiscountAmountElement(Element, String, String), createAvailablePaymentMethodsElement(OrderBaseSearchResultBean, Element)

• createContractIDElement

  protected org.w3c.dom.Element createContractIDElement(org.w3c.dom.Element aParentElement,
                                            OrderItemDataBean bnOrderItem)
                                                 throws ECException
  

  This method creates elements related to the contract ID.

  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>
  
   
  

  Parameters:

  aParentElement - The parent which the elements will build on.

  bnOrderItem - The bean which contains the order item information.

  Returns:

  The DocumentReferences element created.

  Throws:

  ECException

• createDiscountAmountElement

  protected org.w3c.dom.Element createDiscountAmountElement(org.w3c.dom.Element aParentElement,
                                                java.lang.String astrAmount,
                                                java.lang.String astrCurrency)
                                                     throws ECException
  

  This method creates the DiscountAmountElement element.

    
   <oa:DiscountAmount currency="USD">0.00000</oa:DiscountAmount>
   
  

  Parameters:

  aParentElement - The parent which the DiscountAmountElement element will build on.

  astrAmount - The amount of the discount.

  astrCurrency - The currency of the discount.

  Returns:

  The DiscountAmountElement element.

  Throws:

  ECException

• createPaymentTermsElement

  protected org.w3c.dom.Element createPaymentTermsElement(org.w3c.dom.Element aParentElement,
                                              OrderItemDataBean abnOrderItem)
                                                   throws ECException
  

  This method creates the PaymentTerms element for an order item. This method calls createDiscountAmountElement to create DiscountAmount element. The value of this element contains the discount amount for the order item.

   <wc:PaymentTerms>
                  <oa:DiscountAmount currency="USD">0.00000</oa:DiscountAmount>
   </wc:PaymentTerms>
   
  

  Parameters:

  aParentElement - The parent which the PaymentTerms element will build on.

  abnOrderItem - The bean which contains the order item information.

  Returns:

  The PaymentTerms element.

  Throws:

  ECException

  See Also:

  createDiscountAmountElement(Element, String, String)

• createTotalElement

  protected org.w3c.dom.Element createTotalElement(org.w3c.dom.Element aParentElement,
                                       java.lang.String astrCurrency,
                                       java.lang.String astrTotal)
                                            throws ECException
  

  This method creates the Total element.

  >
   <oa:TotalAmount currency="USD">177.99000</oa:TotalAmount> 
   
  

  Parameters:

  aParentElement - The parent which the Total element will build on.

  astrCurrency - The value used to set the attribute 'currency' of the Total element.

  astrTotal - The value corresponding to the Total element.

  Returns:

  The Total element created.

  Throws:

  ECException

• createMiscellaneousChargeElement

  protected org.w3c.dom.Element createMiscellaneousChargeElement(org.w3c.dom.Element aParentElement,
                                                     java.lang.String astrId,
                                                     java.lang.String astrCurrency,
                                                     java.lang.String astrTotal,
                                                     java.lang.String astrDescription)
                                                          throws ECException
  

  Deprecated. Alternatively use the method createMiscellaneousChargeElement with promotion code as additional parameter.
  This method creates the MiscellaneousCharge element.

  This method also calls the method createTotalElement to create the Total element.

  Parameters:

  aParentElement - The parent element which the MiscellaneousCharge element will build on.

  astrId - The id of the miscellaneous charge.

  astrCurrency - The value used to set the attribute 'currency' of the Total element.

  astrTotal - The value corresponding to the Total element.

  astrDescription - The charge description.

  Returns:

  The MiscellaneousCharge element created.

  Throws:

  ECException

  See Also:

  createTotalElement(Element, String, String), createMiscellaneousChargeElement(Element, String, String, String, String ,String )

• createMiscellaneousChargeElement

  protected org.w3c.dom.Element createMiscellaneousChargeElement(org.w3c.dom.Element aParentElement,
                                                     java.lang.String astrId,
                                                     java.lang.String astrCurrency,
                                                     java.lang.String astrTotal,
                                                     java.lang.String astrDescription,
                                                     java.lang.String astrPromotionCode)
                                                          throws ECException
  

  This method creates the MiscellaneousCharge element.

  This method also calls the method createTotalElement to create the Total element. The following sample shows the structure of the MiscellaneousCharge

   <oa:MiscellaneousCharge> <!-- salesContainer.addMiscellaneousCharge -->
      <oa:Id>10001</oa:Id>  <!-- miscCharge.setUniqueIdentifier -->
      <oa:Total currency="USD">10.00</oa:Total>  <!-- miscCharge.setCurrency and miscCharge.setAmount -->
      <oa:Description>Surchange Adjustment</oa:Description> <!-- miscCharge.setDescription() -->
   <wc:PromotionCode> 
                  <wc:Code>A12-34</wc:Code; <!--  miscCharge.setPromotionCode()       -->
   </wc:PromotionCode> 
   </oa:MiscellaneousCharge>
   
  

  Parameters:

  aParentElement - The parent element which the MiscellaneousCharge element will build on.

  astrId - The id of the miscellaneous charge.

  astrCurrency - The value used to set the attribute 'currency' of the Total element.

  astrTotal - The value corresponding to the Total element.

  astrDescription - The charge description.

  astrPromotionCode - The promotion code.

  Returns:

  The MiscellaneousCharge element created.

  Throws:

  ECException

  See Also:

  createTotalElement(Element, String, String)

• createOrderItemLevelMiscellaneousChargeElement

  protected org.w3c.dom.Element createOrderItemLevelMiscellaneousChargeElement(org.w3c.dom.Element aParentElement,
                                                                   OrderItemAdjustmentDataBean orderItemAdjustment,
                                                                   OrderItemDataBean abnOrderItem,
                                                                   java.lang.String astrPromotionCode)
                                                                        throws ECException
  

  This method creates the order item levelMiscellaneousCharge element. The following sample shows the structure of the MiscellaneousCharge

   <oa:MiscellaneousCharge> <!-- salesContainer.addMiscellaneousCharge -->
      <oa:Id>10001</oa:Id>  <!-- miscCharge.setUniqueIdentifier -->
      <oa:Total currency="USD">10.00</oa:Total>  <!-- miscCharge.setCurrency and miscCharge.setAmount -->
      <oa:Description>Surchange Adjustment</oa:Description> <!-- miscCharge.setDescription() -->
   <wc:PromotionCode> 
                  <wc:Code>A12-34</wc:Code; <!--  miscCharge.setPromotionCode()       -->
   </wc:PromotionCode> 
   <UserData>    <!-- createUserdataInMiscellaneousChargeElement(Element) -->
                  <UserDataField name="Name">"Value"</UserDataField>
   <UserData/>
   </oa:MiscellaneousCharge>
   
  

  Parameters:

  aParentElement - The parent element which the MiscellaneousCharge element will build on.

  orderItemAdjustment - The order item adjustment bean.

  abnOrderItem - The order item data bean.

  astrPromotionCode - The promotion code.

  Returns:

  The MiscellaneousCharge element created.

  Throws:

  ECException

  See Also:

  createMiscellaneousChargeElement(Element, String, String, String, String, String), createUserdataInOrderItemMiscellaneousChargeElement(OrderItemDataBean, OrderItemAdjustmentDataBean, Element)

• createOrderLevelMiscellaneousChargeElement

  protected org.w3c.dom.Element createOrderLevelMiscellaneousChargeElement(org.w3c.dom.Element aParentElement,
                                                               OrderBaseSearchResultBean searchResult,
                                                               OrderAdjustmentDataBean orderAdjustmentdatabean,
                                                               java.lang.String promotionCode)
                                                                    throws ECException
  

  This method creates the MiscellaneousCharge element. The following sample shows the structure of the MiscellaneousCharge

   <oa:MiscellaneousCharge> <!-- salesContainer.addMiscellaneousCharge -->
      <oa:Id>10001</oa:Id>  <!-- miscCharge.setUniqueIdentifier -->
      <oa:Total currency="USD">10.00</oa:Total>  <!-- miscCharge.setCurrency and miscCharge.setAmount -->
      <oa:Description>Surchange Adjustment</oa:Description> <!-- miscCharge.setDescription() -->
   <wc:PromotionCode> 
                  <wc:Code>A12-34</wc:Code; <!--  miscCharge.setPromotionCode()       -->
   </wc:PromotionCode> 
   <UserData>    <!-- createUserdataInMiscellaneousChargeElement(Element) -->
                  <UserDataField name="Name">"Value"</UserDataField>
   <UserData/>
   </oa:MiscellaneousCharge>
   
  

  Parameters:

  aParentElement - The parent element which the MiscellaneousCharge element will build on.

  searchResult - The search result bean.

  orderAdjustmentdatabean - The order adjustment data bean.

  promotionCode - The promotion code.

  Returns:

  The MiscellaneousCharge element created.

  Throws:

  ECException

  See Also:

  createMiscellaneousChargeElement(Element, String, String, String, String, String), createUserdataInMiscellaneousChargeElement(OrderAdjustmentDataBean, OrderBaseSearchResultBean, Element)

• createUserdataInOrderItemMiscellaneousChargeElement

  protected org.w3c.dom.Element createUserdataInOrderItemMiscellaneousChargeElement(OrderItemDataBean abnOrderItem,
                                                                        OrderItemAdjustmentDataBean orderAdjustmentdatabean,
                                                                        org.w3c.dom.Element miscChargeElement)
                                                                             throws ECException
  

  This is an empty method to create the UserData element for MiscellaneousCharge. This could be extended by end user to add custom information in response BOD.

   ...
   Element userDataElement = createWCDocumentElement(miscChargeElement, BodConstants.TAG_WC_USER_DATA);
   createUserDataFieldElement(userDataElement, fieldName, fieldValue);
   ...
   return userDataElement;
   
  

  Parameters:

  abnOrderItem - the item level data bean.

  orderAdjustmentdatabean - the item level adjustment data bean.

  miscChargeElement - the miscellaneous charge element

  Returns:

  null

  Throws:

  ECException

• createUserdataInMiscellaneousChargeElement

  protected org.w3c.dom.Element createUserdataInMiscellaneousChargeElement(OrderAdjustmentDataBean orderAdjustmentdatabean,
                                                               OrderBaseSearchResultBean searchResult,
                                                               org.w3c.dom.Element miscChargeElement)
                                                                    throws ECException
  

  This is an empty method to create the UserData element for MiscellaneousCharge. This could be extended by end user to add custom information in response BOD.

   ...
   Element userDataElement = createWCDocumentElement(miscChargeElement, BodConstants.TAG_WC_USER_DATA);
   createUserDataFieldElement(userDataElement, fieldName, fieldValue);
   ...
   return userDataElement;
   
  

  Parameters:

  orderAdjustmentdatabean - the item level adjustment data bean.

  searchResult - the search result data bean

  miscChargeElement - the miscellaneous charge element.

  Returns:

  null

  Throws:

  ECException

• createUserDataInPaymentMethodsElement

  protected org.w3c.dom.Element createUserDataInPaymentMethodsElement(PaymentTCInfo paymentTCInfo,
                                                          OrderBaseSearchResultBean abnOrderBaseSearchResult,
                                                          org.w3c.dom.Element paymentMethodElement)
                                                               throws ECException
  

  This is an empty method to create the UserData element for PaymentMethods. This could be extended by end user to add custom information in response BOD.

   ...
   Element userDataElement = createWCDocumentElement(paymentMethodElement, BodConstants.TAG_WC_USER_DATA);
   createUserDataFieldElement(userDataElement, fieldName, fieldValue);
   ...
   return userDataElement;
   
  

  Parameters:

  paymentTCInfo - the paymentInfo

  abnOrderBaseSearchResult - search result bean

  paymentMethodElement - payment method element

  Returns:

  null

  Throws:

  ECException

• createTransportationChargeElement

  protected org.w3c.dom.Element createTransportationChargeElement(org.w3c.dom.Element aParentElement,
                                                      java.lang.String astrCurrency,
                                                      java.lang.String astrTotal)
                                                           throws ECException
  

  This method creates the TransportationCharge element.

  This method also calls the method createTotalElement to create the Total element.

  Parameters:

  aParentElement - The parent which the TransportationCharge elements build on.

  astrCurrency - the currency used.

  astrTotal - the total of the charges.

  Returns:

  The TransportationCharge element created.

  Throws:

  ECException

  See Also:

  createTotalElement(Element, String, String)

• createChargesElement

  protected org.w3c.dom.Element createChargesElement(OrderBaseSearchResultBean abnOrderBaseSearchResult,
                                         org.w3c.dom.Element aParentElement)
                                              throws ECException
  

  This method creates the Charges element for an order.

  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.

   <oa:Charges>
                  <oa:TransportationCharge>
                  .                                                       <!-- Created by createTransportationChargeElement method -->
                  </oa:TransportationCharge>
                  <oa:MiscellaneousCharge>
                  .                                                       <!-- Created by createMiscellaneousChargeElement method -->
                  </oa:MiscellaneousCharge>
   </oa:Charges>
   
  

  Parameters:

  abnOrderBaseSearchResult - The bean which contains the order information.

  aParentElement - The parent which the Charges element will build on.

  Returns:

  The Charges element created.

  Throws:

  ECException

  See Also:

  createTransportationChargeElement(Element, String, String), createOrderLevelMiscellaneousChargeElement(Element, OrderBaseSearchResultBean, OrderAdjustmentDataBean, String)

• createChargesElement

  protected org.w3c.dom.Element createChargesElement(org.w3c.dom.Element aParentElement,
                                         OrderItemDataBean abnOrderItem)
                                              throws ECException
  

  This method creates the Charges element for an order item.

  This methods calls the createMiscellaneousChargeElement to build the MiscellaneousCharge element for order item surcharge adjustments and order item discount adjustments.

   <oa:Charges>
                  <oa:MiscellaneousCharge>
                  .                                                       <!-- Created by createMiscellaneousChargeElement method -->
                  </oa:MiscellaneousCharge>
   </oa:Charges>
   
  

  Parameters:

  aParentElement - The parent which the Charges element will build on.

  abnOrderItem - The bean which contains order item information.

  Returns:

  The Charges element created.

  Throws:

  ECException

  See Also:

  createOrderItemLevelMiscellaneousChargeElement(Element, OrderItemAdjustmentDataBean, OrderItemDataBean, String)

• getShowCustomerBuilder

  protected IShowCustomer getShowCustomerBuilder()
  

  This method gets the response BOD builder for the action Get on the noun Customer. If a reference to the builder is cached, it will return the reference. Otherwise, this method will first try to call the TelesalesResponseBuilderFactory to load the proper response builder for action Get on the noun Customer, and cast the object to the IShowCustomer interface, and save the reference.

  Returns:

  The response builder.

• getShowElectronicCatalogBuilder

  protected IShowElectronicCatalog getShowElectronicCatalogBuilder()
  

  This method gets the response builder for the action Get on the noun ElectronicCatalog. If a reference to the builder is saved, this method will return the reference. Otherwise, this method will first try to call the TelesalesResponseBuilderFactory to load the proper response BOD builder for the action Get on the noun ElectronicCatalog, and cast the object to the IShowElectronicCatalog interface, and save the reference.

  Returns:

  The response builder.

• createCustomerPartyElement

  protected org.w3c.dom.Element createCustomerPartyElement(OrderBaseSearchResultBean abnOrderBaseSearchResult,
                                               org.w3c.dom.Element aParentElement)
                                                    throws ECException
  

  This method builds the CustomerParty element. The CustomerParty element created by this method contains the member ID of the customer. The element has the following structure:

          <CustomerParty>
                  <PartyId>
                          <Id>100</Id>
                  </PartyId>
          </CustomerParty>
   
  

  Parameters:

  abnOrderBaseSearchResult - The bean which contains the order information.

  aParentElement - The parent element which the CustomerParty element will build on.

  Returns:

  The CustomerParty element created.

  Throws:

  ECException

• createPaymentInstructionElement

  protected org.w3c.dom.Element createPaymentInstructionElement(java.util.HashMap ahashProtocolData,
                                                    EDPPaymentInstruction aPiData,
                                                    org.w3c.dom.Element aParentElement,
                                                    OrderBaseSearchResultBean abnOrderBaseSearchResult)
                                                         throws ECException
  

  This method builds the PaymentInstruction element. This method also calls the createUserDataFieldElement to create the wc:UserDataField element.

  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>
  
   
  

  Parameters:

  ahashProtocolData - The payment data.

  aPiData - The payment instruction information.

  aParentElement - The parent which the PaymentInstruction element will build on.

  abnOrderBaseSearchResult - The order search result bean

  Returns:

  The PaymentInstruction element created.

  Throws:

  ECException

  See Also:

  TelesalesResponseBuilderImpl.createUserDataFieldElement(Element, String, String)

• createBillToPartyElement

  protected org.w3c.dom.Element createBillToPartyElement(OrderBaseSearchResultBean abnOrderBaseSearchResult,
                                             org.w3c.dom.Element aParentElement)
                                                  throws ECException
  

  This method builds the BillToParty element.

  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'. Additionally it invokes the createUserdataInBillToPartyElement(EDPPaymentInstruction, Element) method to create the user data under BillToParty element.

  Parameters:

  abnOrderBaseSearchResult - The bean which contains the order information.

  aParentElement - The parent element which the BillToParty element will build on.

  Returns:

  The BillToParty element created.

  Throws:

  ECException

  See Also:

  TelesalesResponseBuilderImpl.createPartyIdElement(String, Element), createPaymentInstructionElement(HashMap, EDPPaymentInstruction, Element, OrderBaseSearchResultBean), createUserdataInBillToPartyElement(HashMap, EDPPaymentInstruction, OrderBaseSearchResultBean, Element)

• createUserdataInBillToPartyElement

  protected org.w3c.dom.Element createUserdataInBillToPartyElement(java.util.HashMap ahashProtocolData,
                                                       EDPPaymentInstruction aPiData,
                                                       OrderBaseSearchResultBean abnOrderBaseSearchResult,
                                                       org.w3c.dom.Element aParentElement)
                                                            throws ECException
  

  This is an empty method to create the UserData element for BillToParty. This could be extended by end user to add custom information in response BOD.

   ...
   Element userDataElement = createWCDocumentElement(billToPartyElement, BodConstants.TAG_WC_USER_DATA);
   createUserDataFieldElement(userDataElement, fieldName, fieldValue);
   ...
   return userDataElement;
   
  

  Parameters:

  ahashProtocolData - the HashMap

  aPiData - the payment instruction

  abnOrderBaseSearchResult - Order base search result bean

  aParentElement - the bill to party element

  Returns:

  null

  Throws:

  ECException

• createPartiesElement

  protected org.w3c.dom.Element createPartiesElement(OrderBaseSearchResultBean abnOrderBaseSearchResult,
                                         org.w3c.dom.Element aParentElement)
                                              throws ECException
  

  This method builds the Parties Element.

  This methods calls the method createCustomerPartyElement to create the CustomerParty element.

  This methods calls the method createBillToPartyElement to create the BillToParty element.

  Parameters:

  abnOrderBaseSearchResult - The bean which contains the order information.

  aParentElement - The parent element which the Parties Element will build on.

  Returns:

  The Parties Element created.

  Throws:

  ECException

  See Also:

  createCustomerPartyElement(OrderBaseSearchResultBean, Element), createBillToPartyElement(OrderBaseSearchResultBean, Element)

• createTaxElement

  protected org.w3c.dom.Element createTaxElement(OrderBaseSearchResultBean abnOrderBaseSearchResult,
                                     org.w3c.dom.Element aParentElement)
                                          throws ECException
  

  This method builds the Tax element. This method calls the createTransportationChargeElement to create the TransportationCharge element.

  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>
  
   
  

  Parameters:

  abnOrderBaseSearchResult - The bean which contains the order information.

  aParentElement - The parent element which the Tax element will build on.

  Returns:

  The Tax element created.

  Throws:

  ECException

  See Also:

  createTransportationChargeElement(Element, String, String)

• createExtendedPriceElement

  protected org.w3c.dom.Element createExtendedPriceElement(org.w3c.dom.Element aParentElement,
                                               java.lang.String astrPrice,
                                               java.lang.String astrCurrency)
                                                    throws ECException
  

  This method builds the ExtendedPrice element.

  Parameters:

  aParentElement - The parent element which the ExtendedPrice element will build on.

  astrPrice - The value of the extended price.

  astrCurrency - The currency used.

  Returns:

  The ExtendedPrice element created.

  Throws:

  ECException

• createHeaderElement

  protected org.w3c.dom.Element createHeaderElement(OrderBaseSearchResultBean abnOrderBaseSearchResult,
                                        org.w3c.dom.Element aParentElement)
                                             throws ECException
  

  This method creates the Header element.

  This method calls the following methods to create the child elements of the Header element:

  • method createDocumentIdsElement to create DocumentIds element.
  • method createOrderStatusElement to create OrderStatus element.
  • method createQuoteExpiryPeriodElement to create expirePeriod element.
  • method createExtendedPriceElement to create ExtendedPrice element whose value contains the order's total amount.
  • method createPaymentTermsElement to create PaymentTerms element.
  • method createChargesElement to create Charges element.
  • method createPartiesElement to create Parties element.
  • method createCommerceAreaElement to create CommerceArea element.
  • method createTaxElement to create Tax element.
  • method createBusinessChannelElement to create BusinessChannel element.
  • method createOrderCurrentChargesElement to create OrderCurrentCharges element.
  • method createOrderBlocksElement to create OrderBlocks element.
  • method createOrderUnpaidBalanceElement to create OrderUnpaidBalance element.
  • method createOrderPromotionCodesElement to create OrderPromotionCodes element

  This method also creates the following child elements:

  • TotalAmount.
  • PONumber.
  • PONumberRequired.
  • IsPreparedInd, that indicates if the order is prepared or not.
  • CurrentOrderEditorId.

   <wc:Header>
                  <oa:DocumentIds>
                  .                                       <!--  Created by createDocumentIdsElement method -->
                  </oa:DocumentIds>
                  <oa:OrderStatus>
                  .                                       <!--  Created by createOrderStatusElement method -->
                  </oa:OrderStatus>
                  <wc:isEmpty><!--  Created by createIsEmptyElement --></wc:isEmpty>            
                  <wc:NextAvailableTieCode><!-- Created by createNextAvailableTieCodeElement  --></wc:NextAvailableTieCode>
                  <oa:ExtendedPrice currency="USD">159.99000</oa:ExtendedPrice>
                  <oa:TotalAmount currency="USD">177.99000</oa:TotalAmount>
                  <wc:PaymentTerms>
                  .                                       <!--  Created by createPaymentTermsElement method -->
                  </wc:PaymentTerms>
                  <oa:Charges>
                  .                                       <!--  Created by createChargesElement method -->
                  </oa:Charges>
                  <oa:Parties>
                  .                                       <!--  Created by createPartiesElement method -->
                  </oa:Parties>
                  <oa:Tax>
                  .                                       <!--  Created by createTaxElement method -->
                  </oa:Tax>
                  <oa:LastModificationDateTime>2006 05 12 19:08:44.139</oa:LastModificationDateTime>
                  <wc:ShipAsComplete>Y</wc:ShipAsComplete>
                  <wc:OrderPlacedDate>2006 05 12 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 createOrderCurrentChargesElement method -->
                  </wc:OrderCurrentCharges>
                  <wc:OrderUnpaidBalance currency="USD">0.00000</wc:OrderUnpaidBalance>
                  <wc:OrderPromotionCodes>
                                                          <!-- Created by  createOrderPromotionCodesElement method -->
                  <wc:OrderPromotionCodes>
   
   </wc:Header>
   
  

  Parameters:

  abnOrderBaseSearchResult - The bean which contains the order information.

  aParentElement - The parent element which the Header element will build on.

  Returns:

  The Header element created.

  Throws:

  ECException

  See Also:

  TelesalesResponseBuilderImpl.createDocumentIdsElement(Element, String), createOrderStatusElement(OrderBaseSearchResultBean, Element), createExtendedPriceElement(Element, String, String), createPaymentTermsElement(OrderBaseSearchResultBean, Element), createChargesElement(OrderBaseSearchResultBean, Element), createPartiesElement(OrderBaseSearchResultBean, Element), createBusinessElement(OrderBaseSearchResultBean, Element), createTaxElement(OrderBaseSearchResultBean, Element), createBusinessChannelElement(OrderBaseSearchResultBean, Element), createOrderCurrentChargesElement(OrderBaseSearchResultBean, Element), createOrderUnpaidBalanceElement(OrderBaseSearchResultBean, Element), createOrderBlocksElement(OrderBaseSearchResultBean, Element), createQuoteExpiryPeriodElement(OrderBaseSearchResultBean, Element), createQuoteExpireDateElement(OrderBaseSearchResultBean, Element), createOrderPromotionCodesElement(OrderBaseSearchResultBean, Element)

• createOrderPromotionCodesElement

  protected void createOrderPromotionCodesElement(OrderBaseSearchResultBean abnOrderBaseSearchResult,
                                      org.w3c.dom.Element headerElement)
                                           throws ECException
  

  This method builds the OrderPromotionCodes element.

  The following is a sample OrderPromotionCodes element that indicates how the element is constructed:

   <OrderPromotionCodes>
      
       <PromotionCode>
      <Code>102</Code> 
            <Description>Save 20% on all Brake Pads!</Description>
                  <UserData>    <!-- createUserdataInPromotionCodesElement() -->
                          <UserDataField name="Name">"Value"</UserDataField>
                  <UserData/>
   </PromotionCode>
      
   </OrderPromotionCodes>
   
  

  Parameters:

  abnOrderBaseSearchResult - The bean which contains the order information.

  headerElement - The parent element which the OrderPromotionCodes element will build on.

  Throws:

  ECException

  See Also:

  createUserdataInPromotionCodesElement(PromotionCodeData, OrderBaseSearchResultBean, Element)

• createQuoteExpiryPeriodElement

  protected org.w3c.dom.Element createQuoteExpiryPeriodElement(OrderBaseSearchResultBean abnOrderBaseSearchResult,
                                                   org.w3c.dom.Element headerElement)
                                                        throws ECException
  

  This method builds the expirePeriod element.

  The following is a sample expirePeriod element that indicates how the element is constructed:

                  <wc:expirePeriod>172800</wc:expirePeriod>
   
  

  Parameters:

  abnOrderBaseSearchResult - The bean which contains the order information.

  headerElement - The parent element which the expirePeriod element will build on.

  Returns:

  The expirePeriod element that contains the quote expiry period in seconds.

  Throws:

  ECException

• createIsEmptyElement

  protected org.w3c.dom.Element createIsEmptyElement(OrderBaseSearchResultBean abnOrderBaseSearchResult,
                                         org.w3c.dom.Element headerElement)
                                              throws ECException
  

  This method builds the isEmpty element.

  The following is a sample isEmpty element that indicates how the element is constructed:

                  <wc:isEmpty>false</wc:isEmpty>
   
  

  Parameters:

  abnOrderBaseSearchResult - The bean which contains the order information.

  headerElement - The parent element which the expirePeriod element will build on.

  Returns:

  The expirePeriod element that contains the quote expiry period in seconds.

  Throws:

  ECException

• createNextAvailableTieCodeElement

  protected org.w3c.dom.Element createNextAvailableTieCodeElement(OrderBaseSearchResultBean abnOrderBaseSearchResult,
                                                      org.w3c.dom.Element headerElement)
                                                           throws ECException
  

  This method builds the NextAvailableTieCode element.

  The following is a sample NextAvailableTieCode element that indicates how the element is constructed:

                  <wc:NextAvailableTieCode>1</wc:NextAvailableTieCode>
   
  

  Parameters:

  abnOrderBaseSearchResult - The bean which contains the order information.

  headerElement - The parent element which the NextAvailableTieCode element will build on.

  Returns:

  The NextAvailableTieCode element that contains the quote expiry period in seconds.

  Throws:

  ECException

• createQuoteExpireDateElement

  protected void createQuoteExpireDateElement(OrderBaseSearchResultBean abnOrderBaseSearchResult,
                                  org.w3c.dom.Element headerElement)
                                       throws ECException
  

  This method builds the expireDate element.

  The following is a sample expireDate element that indicates how the element is constructed:

                  <wc:expireDate>172800/wc:expireDate>
   
  

  Parameters:

  abnOrderBaseSearchResult - The bean which contains the order information.

  headerElement - The parent element which the expireDate element will build on.

  Throws:

  ECException

• createOrderItemElement

  protected org.w3c.dom.Element createOrderItemElement(org.w3c.dom.Element aParentElement,
                                           OrderItemDataBean abnOrderItem)
                                                throws ECException
  

  This method builds the OrderItem element for the given order item.

  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>
  
   
  

  Parameters:

  aParentElement - The parent element which the OrderItem element will build on.

  abnOrderItem - The bean which contains the order item information.

  Returns:

  The OrderItem element created.

  Throws:

  ECException

• createOrderItemStatusElement

  protected org.w3c.dom.Element createOrderItemStatusElement(org.w3c.dom.Element aParentElement,
                                                 OrderItemDataBean abnOrderItem)
                                                      throws ECException
  

  This method creates the OrderStatus element for an order item.

  This method creates the child element CODE. If the order item is editable, the CODE will have value 'YES'. Otherwise, the value is 'NO'.

  Parameters:

  aParentElement - The parent element which the OrderStatus element will build on.

  abnOrderItem - The bean which contains the order item information.

  Returns:

  The OrderStatus element created.

  Throws:

  ECException

• createUnitPriceElement

  protected org.w3c.dom.Element createUnitPriceElement(org.w3c.dom.Element aParentElement,
                                           OrderItemDataBean abnOrderItem)
                                                throws ECException
  

  This method builds the UnitPrice element for an order item.

  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>
  
   
  

  Parameters:

  aParentElement - The parent element which the UnitPrice element will build on.

  abnOrderItem - The bean which contains the order item information.

  Returns:

  The UnitPrice element created.

  Throws:

  ECException

• createPartiesElement

  protected org.w3c.dom.Element createPartiesElement(org.w3c.dom.Element aParentElement,
                                         OrderItemDataBean abnOrderItem)
                                              throws ECException
  

  This method builds the Parties Element for the given order item. The value of this element is the current shipping destination for the order item and the list of available customer shipping destinations.

  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>
  
   
  

  Parameters:

  aParentElement - The parent element which the Parties Element will build on.

  abnOrderItem - The bean which contains the order item information.

  Returns:

  The Parties Element created.

  Throws:

  ECException

• createTransportationTermElement

  protected org.w3c.dom.Element createTransportationTermElement(org.w3c.dom.Element aParentElement,
                                                    OrderItemDataBean abnOrderItem)
                                                         throws ECException
  

  This method builds the TransportationTerm element for an order item. This method creates child element TermCode. The value of this element is the current shipping carrier identifier for the order item.

  Parameters:

  aParentElement - The parent element which the TransportationTerm element will build on.

  abnOrderItem - The bean which contains the order item information.

  Returns:

  The TransportationTerm element created.

  Throws:

  ECException

• createAllocQuantityElement

  protected org.w3c.dom.Element createAllocQuantityElement(org.w3c.dom.Element aParentElement,
                                               java.lang.String astrQuantity)
                                                    throws ECException
  

  This method builds the AllocQuantity element.

  Parameters:

  aParentElement - The parent element which the AllocQuantity Element builds on.

  astrQuantity - The value of the allocated quantity.

  Returns:

  The AllocQuantity Element created.

  Throws:

  ECException

• createSubLineElement

  protected org.w3c.dom.Element createSubLineElement(org.w3c.dom.Element aParentElement,
                                         OrderItemDataBean abnOrderItem)
                                              throws ECException
  

  This method builds the SubLine Element. The value of this element contains the fulfillment center, quantity allocated in each center, allocation status and ship date for the order item.

  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>
   
  

  Parameters:

  aParentElement - The parent element which the SubLine Element will build on.

  abnOrderItem - The bean which contains the order item information.

  Returns:

  The SubLine Element.

  Throws:

  ECException

• createTieCodeElement

  protected org.w3c.dom.Element createTieCodeElement(org.w3c.dom.Element aParentElement,
                                         OrderItemDataBean abnOrderItem)
                                              throws ECException
  

  This method builds the TieCode element for the given order item.

  Parameters:

  aParentElement - The parent element which the TieCode element will build on.

  abnOrderItem - The bean which contains the order item information.

  Returns:

  The TieCode element created.

  Throws:

  ECException

• createAvailableShippingModesElement

  protected org.w3c.dom.Element createAvailableShippingModesElement(org.w3c.dom.Element aParentElement,
                                                        OrderItemDataBean abnOrderItem)
                                                             throws ECException
  

  This method builds the AvailShippingModes element for the given line entry.

  Parameters:

  aParentElement - The parent element which the AvailShippingModes element will build on.

  abnOrderItem - The bean which contains the order item information.

  Returns:

  The AvailShippingModes element created.

  Throws:

  ECException

  See Also:

  createUserDataInAvailableShippingModesElement(ShippingModeDataBean, OrderItemDataBean, Element)

• createElectronicCatalogElement

  protected org.w3c.dom.Element createElectronicCatalogElement(org.w3c.dom.Element aParentElement,
                                                   OrderItemDataBean abnOrderItem,
                                                   OrderBaseSearchResultBean obsrb)
                                                        throws ECException
  

  This method builds the ElectronicCatalog element.

  If the value of OrderBaseSearchResultBean.getPromotions() is false, and if the value of OrderBaseSearchResultBean.getOrderItemDetailsId() is false, then null is returned by the method.

  Otherwise this method will build the ElectronicCatalog element.

  Parameters:

  aParentElement - The parent element which the ElectronicCatalog element will build on.

  abnOrderItem - The bean which contains the order item information.

  obsrb - an OrderBaseSearchResultBean

  Returns:

  The ElectronicCatalog element.

  Throws:

  ECException

• createNeedToDeliveryDateElement

  protected org.w3c.dom.Element createNeedToDeliveryDateElement(org.w3c.dom.Element aParentElement,
                                                    OrderItemDataBean abnOrderItem)
                                                         throws ECException
  

  This method creates the NeedToDeliveryDate element. The value is the requested shipping date for the order item.

  Parameters:

  aParentElement - The parent element which the NeedToDeliveryDate element will build on.

  abnOrderItem - The bean which contains the order item information.

  Returns:

  The NeedToDeliveryDate element.

  Throws:

  ECException

• createIsExpediteElement

  protected org.w3c.dom.Element createIsExpediteElement(org.w3c.dom.Element aParentElement,
                                            OrderItemDataBean abnOrderItem)
                                                 throws ECException
  

  This method creates the ExpediteOrderItem element. The value is Y if the order item has to be expedited, otherwise the value is N.

  Parameters:

  aParentElement - The parent element which the ExpediteOrderItem element will build on.

  abnOrderItem - The bean which contains the order item information.

  Returns:

  The ExpediteOrderItem element.

  Throws:

  ECException

• createOrderShippingInformationElement

  protected org.w3c.dom.Element createOrderShippingInformationElement(OrderBaseSearchResultBean abnOrderBaseSearchResult,
                                                          org.w3c.dom.Element aParentElement)
                                                               throws ECException
  

  This method creates the OrderShippingInformation Element and its sub-elements. It internally calls createShippingAdjustmentsElement, createUsableShipChargesAndAccountByShipModeElements, createShippingInstructionsElement, and createShippingCarriersElement

  Parameters:

  abnOrderBaseSearchResult - The bean which contains the sales order information.

  aParentElement - The parent which the OrderShippingInformation element builds on.

  Returns:

  A OrderShippingInformation Element.

  Throws:

  ECException - An ECSystemException will be thrown when error occurs.

• createOrderHistoryExistedFlagElement

  protected org.w3c.dom.Element createOrderHistoryExistedFlagElement(OrderBaseSearchResultBean abnOrderBaseSearchResult,
                                                         org.w3c.dom.Element aParentElement)
                                                              throws ECException
  

  This method creates the OrderHistoryExistedFlagElement Element and its sub elements. The value is true if the order history exists, false otherwise.

  Parameters:

  abnOrderBaseSearchResult - The bean which contains the sales order information.

  aParentElement - The parent element which the OrderHistoryExistedFlagElement builds on.

  Returns:

  A OrderHistoryExistedFlagElement Element.

  Throws:

  ECException - An ECSystemException will be thrown when error occurs.

• createUsableShipChargesAndAccountByShipModeElements

  protected void createUsableShipChargesAndAccountByShipModeElements(OrderBaseSearchResultBean abnOrderBaseSearchResult,
                                                         org.w3c.dom.Element aParentElement)
                                                              throws ECException
  

  This method calls getUsableShipChargesAndAccountByShipModeDataBean method on the specified OrderDataBean contained in the given OrderBaseSearchResultBean to obtain a list of available shipping modes. For each of the shipping mode, this method calls createShipModeElement which builds the ship charge and account sub-elements for the shipping mode. The result will be stored in the usableShipChargesAndAccountByShipMode element.

  Parameters:

  abnOrderBaseSearchResult - The bean which contains the sales order information.

  aParentElement - The parent which usableShipChargesAndAccountByShipMode element will build on.

  Throws:

  ECException - An ECSystemException will be thrown when error occurs.

• createShipChargeElement

  protected void createShipChargeElement(org.w3c.dom.Element aParentElement,
                             ShipChargeTCPolicyData[] shipChargeTCPolicyData)
                                  throws ECException
  

  This method creates the shipCharge element.

  Parameters:

  aParentElement - The parent element which the shipCharge element will build on.

  shipChargeTCPolicyData - A list of shipping charge policy

  Throws:

  ECException

  See Also:

  createSingleShipChargeElement(Element, ShipChargeTCPolicyData)

• createSingleShipChargeElement

  protected void createSingleShipChargeElement(org.w3c.dom.Element aParentElement,
                                   ShipChargeTCPolicyData shipChargeTCPolicyData)
                                        throws ECException
  

  This method creates the shipCharge element.

  Parameters:

  aParentElement - The parent element which the shipCharge element will build on.

  shipChargeTCPolicyData - A list of shipping charge policy

  Throws:

  ECException

  See Also:

  createUserdataInShipChargeElement(ShipChargeTCPolicyData, Element)

• createUserdataInShipChargeElement

  protected org.w3c.dom.Element createUserdataInShipChargeElement(ShipChargeTCPolicyData shipChargeTCPolicyData,
                                                      org.w3c.dom.Element shipChargeElement)
                                                           throws ECException
  

  This is an empty method to create the UserData element for ShipCharge. This could be extended by end user to add custom information in response BOD.

   ...
   Element userDataElement = createWCDocumentElement(shipChargeElement, BodConstants.TAG_WC_USER_DATA);
   createUserDataFieldElement(userDataElement, fieldName, fieldValue);
   ...
   return userDataElement;
   
  

  Parameters:

  shipChargeTCPolicyData - data bean

  shipChargeElement - the ship charge element

  Returns:

  null

  Throws:

  ECException

• createUserDataInAvailableShippingModesElement

  protected org.w3c.dom.Element createUserDataInAvailableShippingModesElement(ShippingModeDataBean bnShippingModeBean,
                                                                  OrderItemDataBean abnOrderItem,
                                                                  org.w3c.dom.Element shippingModeElement)
                                                                       throws ECException
  

  This is an empty method to create the UserData element for AvailableShippingMode. This could be extended by end user to add custom information in response BOD.

   ...
   Element userDataElement = createWCDocumentElement(shippingModeElement, BodConstants.TAG_WC_USER_DATA);
   createUserDataFieldElement(userDataElement, fieldName, fieldValue);
   ...
   return userDataElement;
   
  

  Parameters:

  bnShippingModeBean - data bean

  abnOrderItem - the order item data bean

  shippingModeElement - the shipping mode parent element for user data

  Returns:

  null

  Throws:

  ECException

• createUserdataInPromotionCodesElement

  protected org.w3c.dom.Element createUserdataInPromotionCodesElement(PromotionCodeData orderPromotionCodeData,
                                                          OrderBaseSearchResultBean abnOrderBaseSearchResult,
                                                          org.w3c.dom.Element appliedPromotionCode)
                                                               throws ECException
  

  This is an empty method to create the UserData element for PromotionCode. This could be extended by end user to add custom information in response BOD.

   ...
   Element userDataElement = createWCDocumentElement(shipChargeElement, BodConstants.TAG_WC_USER_DATA);
   createUserDataFieldElement(userDataElement, fieldName, fieldValue);
   ...
   return userDataElement;
   
  

  Parameters:

  orderPromotionCodeData - promotion code data

  abnOrderBaseSearchResult - search result bean

  appliedPromotionCode - the parent element

  Returns:

  null

  Throws:

  ECException

• createShipModeElement

  protected void createShipModeElement(org.w3c.dom.Element aParentElement,
                           ShipChargesByShipMode shipChargesByShipMode)
                                throws ECException
  

  This method creates the shipMode element. This method calls createShipChargeElement to build the shipping charge and account sub-element.

  Parameters:

  aParentElement - The parent element which the shipMode element will build on.

  shipChargesByShipMode - The ship charge mode

  Throws:

  ECException

  See Also:

  createUserdataInShipModeElement(ShipChargesByShipMode, Element)

• createUserdataInShipModeElement

  protected org.w3c.dom.Element createUserdataInShipModeElement(ShipChargesByShipMode shipChargesByShipMode,
                                                    org.w3c.dom.Element shipModeElement)
                                                         throws ECException
  

  This is an empty method to create the UserData element for ShipMode. This could be extended by end user to add custom information in response BOD.

   ...
   Element userDataElement = createWCDocumentElement(shipModeElement, BodConstants.TAG_WC_USER_DATA);
   createUserDataFieldElement(userDataElement, fieldName, fieldValue);
   ...
   return userDataElement;
   
  

  Parameters:

  shipChargesByShipMode - data bean

  shipModeElement - the ship mode element

  Returns:

  null

  Throws:

  ECException

• createShippingInstructionsElements

  protected void createShippingInstructionsElements(OrderBaseSearchResultBean abnOrderBaseSearchResult,
                                        org.w3c.dom.Element aParentElement)
                                             throws ECException
  

  This method calls getShipInstructionsListDataBean method on the specified OrderDataBean contained in the given OrderBaseSearchResultBean to obtain a list of shipping instructions. For each shipping instruction, this method calls createShippingInstructionsElement to create shipping instructions element and its sub elements.

  Parameters:

  abnOrderBaseSearchResult - The bean which contains the sales order information.

  aParentElement - The parent which the ShippingInstructions element will build on.

  Throws:

  ECException - An ECSystemException will be thrown when error occurs.

• createShippingInstructionsElement

  protected org.w3c.dom.Element createShippingInstructionsElement(org.w3c.dom.Element aParentElement,
                                                      ShipInstructionsDataBean bnShipInstructionDataBean)
                                                           throws ECException
  

  This method creates ShippingInstructions element and its sub elements. (ShipModeId, AddressId, and ShippingInstruction)

  Parameters:

  aParentElement - The parent which the ShippingInstructions element builds on.

  bnShipInstructionDataBean - The Shipping instruction dataBean to build the element.

  Returns:

  A ShippingInstructions element.

  Throws:

  ECException - An ECSystemException will be thrown when error occurs.

  See Also:

  createUserdataInShippingInstructionsElement(ShipInstructionsDataBean, Element)

• createUserdataInShippingInstructionsElement

  protected org.w3c.dom.Element createUserdataInShippingInstructionsElement(ShipInstructionsDataBean bnShipInstructionDataBean,
                                                                org.w3c.dom.Element shippingInstructionsElement)
                                                                     throws ECException
  

  This is an empty method to create the UserData element for ShippingInstructions. This could be extended by end user to add custom information in response BOD.

   ...
   Element userDataElement = createWCDocumentElement(shippingInstructionsElement, BodConstants.TAG_WC_USER_DATA);
   createUserDataFieldElement(userDataElement, fieldName, fieldValue);
   ...
   return userDataElement;
   
  

  Parameters:

  bnShipInstructionDataBean - data bean

  shippingInstructionsElement - the shipping instructions element

  Returns:

  null

  Throws:

  ECException

• createShippingCarriersElements

  protected void createShippingCarriersElements(OrderBaseSearchResultBean abnOrderBaseSearchResult,
                                    org.w3c.dom.Element aParentElement)
                                         throws ECException
  

  This method calls the getShipCarrierAccntListDataBean method on the specified OrderDataBean contained in the specified OrderBaseSearchResultBean to obtain a list of shipping carrier accounts. For each shipping carrier account, it calls createShippingCarriersElement to create the shipping carrier element and its sub-elements.

  Parameters:

  abnOrderBaseSearchResult - The bean which contains the sales order information.

  aParentElement - The parent which the Shipping carriers element builds on.

  Throws:

  ECException - An ECSystemException will be thrown when error occurs.

• createShippingCarriersElement

  protected org.w3c.dom.Element createShippingCarriersElement(org.w3c.dom.Element aParentElement,
                                                  ShipCarrAccntDataBean bnShipCarrierAccountDataBean)
                                                       throws ECException
  

  This method creates the ShippingCarriers element and its sub elements. (ShipModeId, CarrierAccount and ShipChargeAccountType)

  Parameters:

  aParentElement - The parent which the ShippingCarriers element builds on.

  bnShipCarrierAccountDataBean - The Shipping carrier account dataBean to build the element.

  Returns:

  A ShippingCarriers element

  Throws:

  ECException - An ECSystemException will be thrown when error occurs.

  See Also:

  createUserdataInShippingCarriersElement(ShipCarrAccntDataBean, Element)

• createUserdataInShippingCarriersElement

  protected org.w3c.dom.Element createUserdataInShippingCarriersElement(ShipCarrAccntDataBean bnShipCarrierAccountDataBean,
                                                            org.w3c.dom.Element shippingCarriersElement)
                                                                 throws ECException
  

  This is an empty method to create the UserData element for ShippingCarriers. This could be extended by end user to add custom information in response BOD.

   ...
   Element userDataElement = createWCDocumentElement(shippingCarriersElement, BodConstants.TAG_WC_USER_DATA);
   createUserDataFieldElement(userDataElement, fieldName, fieldValue);
   ...
   return userDataElement;
   
  

  Parameters:

  bnShipCarrierAccountDataBean - data bean

  shippingCarriersElement - the shipping carriers element

  Returns:

  null

  Throws:

  ECException

• createShippingAdjustmentsElements

  protected void createShippingAdjustmentsElements(OrderBaseSearchResultBean abnOrderBaseSearchResult,
                                       org.w3c.dom.Element aParentElement)
                                            throws ECException
  

  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. For each shipping adjustment, this method calls createShippingAdjustmentsElement to create the shipping adjustments element and its child-elements.

  Parameters:

  abnOrderBaseSearchResult - The bean which contains the sales order search results.

  aParentElement - The parent which the ShippingAdjustments element will build on.

  Throws:

  ECException - An ECSystemException will be thrown when error occurs.

• createShippingAdjustmentElements

  protected org.w3c.dom.Element createShippingAdjustmentElements(ShippingAdjustmentDataBean shipAdjustDataBean,
                                                     org.w3c.dom.Element aParentElement)
                                                          throws ECSystemException
  

  This method creates the ShippingAdjustments element. It also creates the sub elements, ShipModeId, ShippingAdjustmentFloorPercent,ShippingAdjustmentFloorCost, ShippingAdjustmentFloorAmtOff, and PrevShippingAdjustments. The PrevShippingAdjustments element also has child elements.

  Parameters:

  shipAdjustDataBean - The Shipping adjustment dataBean that holds data on shipping adjustments.

  aParentElement - The parent which the ShippingAdjustments element will build on.

  Returns:

  ShippingAdjustments element

  Throws:

  ECException - An ECSystemException will be thrown when error occurs.

  ECSystemException

  See Also:

  createUserdataInShippingAdjustmentElement(ShippingAdjustmentDataBean, Element)

• createUserdataInShippingAdjustmentElement

  protected org.w3c.dom.Element createUserdataInShippingAdjustmentElement(ShippingAdjustmentDataBean shippingAdjustmentDataBean,
                                                              org.w3c.dom.Element shippingAdjustmentElement)
                                                                   throws ECException
  

  This is an empty method to create the UserData element for ShippingAdjustment. This could be extended by end user to add custom information in response BOD.

   ...
   Element userDataElement = createWCDocumentElement(shippingAdjustmentElement, BodConstants.TAG_WC_USER_DATA);
   createUserDataFieldElement(userDataElement, fieldName, fieldValue);
   ...
   return userDataElement;
   
  

  Parameters:

  shippingAdjustmentDataBean - data bean

  shippingAdjustmentElement - the shipping adjustment element

  Returns:

  null

  Throws:

  ECException

• createLineDetailElement

  protected org.w3c.dom.Element createLineDetailElement(OrderItemDataBean[] bnOrderItems,
                                            org.w3c.dom.Element aParentElement,
                                            OrderBaseSearchResultBean abnOrderBaseSearchResult)
                                                 throws ECException
  

  This method creates the order/quote item line element. It also creates the sub elements OrderStatus,ItemId,SupplierItemId,OrderQuantity, UnitPrice,ExtendedPrice,ExcpediteOrderItem and so forth.

  The following child elements also get created:

  • LineNumber
  • OrderQuantity

   <wc:Line>
                  <oa:LineNumber>20002</oa:LineNumber>
                  <oa:OrderStatus>
                  .                                       <!-- Created by createOrderItemStatusElement method -->
                  </oa:OrderStatus>
                  <oa:OrderItem>
                  .                                       <!-- Created by createOrderItemElement method -->
                  </oa:OrderItem>
                  <oa:OrderQuantity uom="NMTOKEN">1</oa:OrderQuantity>
                  <oa:UnitPrice>
                  .                                       <!-- Created by createUnitPriceElement method -->
                  </oa:UnitPrice>
                  <oa:ExtendedPrice currency="USD">159.99000</oa:ExtendedPrice>
                  <wc:ExpediteOrderItem>N</wc:ExpediteOrderItem>
                  <oa:Parties>
                  .                                       <!-- Created by createPartiesElement method -->
                  </oa:Parties>
                  <oa:TransportationTerm>
                  .                                       <!-- Created by createTransportationTermElement method -->
                  </oa:TransportationTerm>
                  <oa:Charges />
                  <wc:PaymentTerms>
                  .                                       <!-- Created by createPaymentTermsElement method -->
                  </wc:PaymentTerms>
                  <oa:DocumentReferences>
                  .                                       <!-- Created by createContractIDElement method -->
                  </oa:DocumentReferences>
                  <wc:AllocatedQuantity uom="NMTOKEN">1</wc:AllocatedQuantity>
                  <wc:TieCode />
                  <wc:ItemCreateDate>2006 05 12 19:05:47.094</wc:ItemCreateDate>
                  <wc:AvailShippingModes>
                  .                                       <!-- Created by createAvailableShippingModesElement method -->
                  </wc:AvailShippingModes>
                  <oa:ElectronicCatalog>
                  .                                       <!-- Created by createElectronicCatalogElement method -->
                  </oa:ElectronicCatalog>
                  <oa:Shipped>
                  .                                       <!-- Created by createItemShippedElement method -->
                  </oa:Shipped>
                  <wc:SubLine>
                  .                                       <!-- Created by createSubLineElement method -->
                  </wc:SubLine>     
   </wc:Line>
  
   This method internally calls the following methods:
    
   
  

  • method createOrderItemElement to create the OrderItem element
  • method createUnitPriceElement to create the UnitPrice element
  • method createExtendedPriceElement to create the ExtendedPrice element
  • method createNeedToDeliveryDateElement to create the NeedToDeliveryDate element
  • method createPartiesElement to create the Parties element
  • method createTransportationTermElement to create the TransportationTerm element
  • method createChargesElement to create the Charges element
  • method createPaymentTermsElement to create the PaymentTerms element
  • method createSubLineElement to create the SubLine element
  • method createAllocQuantityElement to create the AllocQuantity element
  • method createContractIDElement to create the DocumentReferences element
  • method createTieCodeElement to create the TieCodeDescription element
  • method createAvailableShippingModesElement to create the AvailShippingModes element
  • method createElectronicCatalogElement to create the ElectronicCatalog element
  • method createSubLineElement to create the SubLine element
  • method createOrderItemStatusElement to create the OrderStatus element
  • method createIsExpediteElement to create the ExpediteOrderItem element

  Parameters:

  bnOrderItems - the order items.

  aParentElement - the parent which the ShippingAdjustments element will build on.

  abnOrderBaseSearchResult - the search result bean.

  Returns:

  Line elements for each order item.

  Throws:

  ECException - An ECSystemException will be thrown when error occurs.

  See Also:

  createSingleLineDetailElement(OrderItemDataBean, Element, OrderBaseSearchResultBean)

• createSingleLineDetailElement

  protected org.w3c.dom.Element createSingleLineDetailElement(OrderItemDataBean bnOrderItem,
                                                  org.w3c.dom.Element aParentElement,
                                                  OrderBaseSearchResultBean abnOrderBaseSearchResult)
                                                       throws ECException
  

  This method creates the order/quote item line element. It also creates the sub elements OrderStatus,ItemId,SupplierItemId,OrderQuantity, UnitPrice,ExtendedPrice,ExcpediteOrderItem and so forth.

  The following child elements also get created:

  • LineNumber
  • OrderQuantity

   <wc:Line>
                  <oa:LineNumber>20002</oa:LineNumber>
                  <oa:OrderStatus>
                  .                                       <!-- Created by createOrderItemStatusElement method -->
                  </oa:OrderStatus>
                  <oa:OrderItem>
                  .                                       <!-- Created by createOrderItemElement method -->
                  </oa:OrderItem>
                  <oa:OrderQuantity uom="NMTOKEN">1</oa:OrderQuantity>
                  <oa:UnitPrice>
                  .                                       <!-- Created by createUnitPriceElement method -->
                  </oa:UnitPrice>
                  <oa:ExtendedPrice currency="USD">159.99000</oa:ExtendedPrice>
                  <wc:ExpediteOrderItem>N</wc:ExpediteOrderItem>
                  <oa:Parties>
                  .                                       <!-- Created by createPartiesElement method -->
                  </oa:Parties>
                  <oa:TransportationTerm>
                  .                                       <!-- Created by createTransportationTermElement method -->
                  </oa:TransportationTerm>
                  <oa:Charges />
                  <wc:PaymentTerms>
                  .                                       <!-- Created by createPaymentTermsElement method -->
                  </wc:PaymentTerms>
                  <oa:DocumentReferences>
                  .                                       <!-- Created by createContractIDElement method -->
                  </oa:DocumentReferences>
                  <wc:AllocatedQuantity uom="NMTOKEN">1</wc:AllocatedQuantity>
                  <wc:TieCode />
                  <wc:ItemCreateDate>2006 05 12 19:05:47.094</wc:ItemCreateDate>
                  <wc:AvailShippingModes>
                  .                                       <!-- Created by createAvailableShippingModesElement method -->
                  </wc:AvailShippingModes>
                  <oa:ElectronicCatalog>
                  .                                       <!-- Created by createElectronicCatalogElement method -->
                  </oa:ElectronicCatalog>
                  <oa:Shipped>
                  .                                       <!-- Created by createItemShippedElement method -->
                  </oa:Shipped>
                  <wc:SubLine>
                  .                                       <!-- Created by createSubLineElement method -->
                  </wc:SubLine>     
   </wc:Line>
  
   This method internally calls the following methods:
    
   
  

  • method createOrderItemElement to create the OrderItem element
  • method createUnitPriceElement to create the UnitPrice element
  • method createExtendedPriceElement to create the ExtendedPrice element
  • method createNeedToDeliveryDateElement to create the NeedToDeliveryDate element
  • method createPartiesElement to create the Parties element
  • method createTransportationTermElement to create the TransportationTerm element
  • method createChargesElement to create the Charges element
  • method createPaymentTermsElement to create the PaymentTerms element
  • method createSubLineElement to create the SubLine element
  • method createAllocQuantityElement to create the AllocQuantity element
  • method createContractIDElement to create the DocumentReferences element
  • method createTieCodeElement to create the TieCodeDescription element
  • method createAvailableShippingModesElement to create the AvailShippingModes element
  • method createElectronicCatalogElement to create the ElectronicCatalog element
  • method createSubLineElement to create the SubLine element
  • method createOrderItemStatusElement to create the OrderStatus element
  • method createIsExpediteElement to create the ExpediteOrderItem element

  Parameters:

  bnOrderItem -

  aParentElement -

  abnOrderBaseSearchResult -

  Returns:

  Line element

  Throws:

  ECException

  See Also:

  OrderBase#createUserdataInLineElement(OrderItemDataBean, Element)

• createUserdataInLineElement

  protected org.w3c.dom.Element createUserdataInLineElement(OrderItemDataBean bnOrderItem,
                                                OrderBaseSearchResultBean abnOrderBaseSearchResult,
                                                org.w3c.dom.Element lineElement)
                                                     throws ECException
  

  This is an empty method to create the UserData element for Line. This could be extended by end user to add custom information in response BOD.

   ...
   Element userDataElement = createWCDocumentElement(lineElement, BodConstants.TAG_WC_USER_DATA);
   createUserDataFieldElement(userDataElement, fieldName, fieldValue);
   ...
   return userDataElement;
   
  

  Parameters:

  bnOrderItem - data bean

  abnOrderBaseSearchResult - order base search result bean

  lineElement - the line element

  Returns:

  null

  Throws:

  ECException

• createLineElement

  protected org.w3c.dom.Element createLineElement(OrderBaseSearchResultBean abnOrderBaseSearchResult,
                                      org.w3c.dom.Element aParentElement)
                                           throws ECException
  

  This method populates the order items from the order base search result bean.

  This method internally invokes the createLineDetailElement after getting order items information based on the getShippedItemsOnly status.

  Parameters:

  abnOrderBaseSearchResult - the bean which contains the order information.

  aParentElement - the parent element which the Line element will build on.

  Returns:

  The Line element created.

  Throws:

  ECException

• createItemShippedElement

  protected org.w3c.dom.Element createItemShippedElement(org.w3c.dom.Element aParentElement,
                                             OrderItemDataBean abnOrderItem)
                                                  throws ECException
  

  This method creates the Shipped element for an order item.

  This method creates the child element CODE. If the order item is shipped, the CODE will have value 'YES'. Otherwise, the value is 'NO'.

  Parameters:

  aParentElement - The parent element which the Shipped element will build on.

  abnOrderItem - The bean which contains the order item information.

  Returns:

  The Shipped element created.

  Throws:

  ECException

• buildNounElement

  protected org.w3c.dom.Element buildNounElement(OrderBaseSearchResultBean abnOrderBaseSearchResult,
                                     org.w3c.dom.Element aParent,
                                     java.lang.String astrNounTagName)
                                          throws ECException
  

  This method builds the common child elements for this noun.

  If the order detailed information is needed (abnOrderBaseSearchResult.getRetrieveDetailsFlag returns true. ), this method calls the buildNounElementDetailInfo method to build the elements. Otherwise, this method calls the buildNounElementBaseInfo method to build the elements.

  Parameters:

  abnOrderBaseSearchResult - The bean which contains the order information.

  aParent - the parent which the noun element will build on.

  astrNounTagName - the tag to be used to create the document element for this noun.

  Returns:

  The noun element created.

  Throws:

  ECException

• buildNounElementBaseInfo

  protected org.w3c.dom.Element buildNounElementBaseInfo(OrderBaseSearchResultBean abnOrderBaseSearchResult,
                                             org.w3c.dom.Element aParentElement)
                                                  throws ECException
  

  This method builds the base information for this noun. This provides brief summary information for this noun. This method calls the createHeaderElementBaseInfo method to create the Header element.

  Parameters:

  abnOrderBaseSearchResult - The bean which contains the order information.

  aParentElement - The parent which the noun element will build on.

  Returns:

  The noun element created.

  Throws:

  ECException

• buildNounElementDetailInfo

  protected org.w3c.dom.Element buildNounElementDetailInfo(OrderBaseSearchResultBean abnOrderBaseSearchResult,
                                               org.w3c.dom.Element aParentElement)
                                                    throws ECException
  

  This method builds the detailed information for this noun.This provides full information for this noun. The method also changes its behavior based on the current values of getHeaderDetails and getItemsDetails flags. If the getItemsDetails is true only createLineElement need to be invoked and hence the methods createHeaderElement, createOrderShippingInformationElement,createOrderHistoryExistedFlagElement would not be invoked. Else all the methods would be invoked.

  This method calls the in this method are:

  • method createHeaderElement to create the Header element
  • method createLineElement to create the Line element
  • method createOrderShippingInformationElement to create the OrderShippingInformation element
  • method createOrderHistoryExistedFlagElement to create the OrderHistoryExistedFlag element

   <wc:SalesOrder>
                  <wc:Header>
                  .                               <!-- Created by createHeaderElement method -->
                  </wc:Header>
                  <wc:Line>
                  .                               <!-- Created by createLineElement method -->
                  </wc:Line>
                  <wc:OrderShippingInformation>
                  .                               <!-- Created by createLineElement method -->
                  </wc:OrderShippingInformation>
                  <wc:OrderHistoryExistedFlag>true</wc:OrderHistoryExistedFlag>
                  <wc:UserData/>
   </wc:SalesOrder>
   
  

  Parameters:

  abnOrderBaseSearchResult - The bean which contains the order information.

  aParentElement - The parent which the noun element will build on.

  Returns:

  The noun element created.

  Throws:

  ECSystemException

  ECException

  See Also:

  createHeaderElement(OrderBaseSearchResultBean, Element), createLineElement(OrderBaseSearchResultBean, Element), createOrderShippingInformationElement(OrderBaseSearchResultBean, Element)

• createHeaderElementBaseInfo

  protected org.w3c.dom.Element createHeaderElementBaseInfo(OrderBaseSearchResultBean abnOrderBaseSearchResult,
                                                org.w3c.dom.Element aParentElement)
                                                     throws ECException
  

  This method creates the Header element which contains a brief information for the header.

  This method calls the following methods to create the child elements of Header element:

  • method createDocumentIdsElement to create DocumentIds element
  • method createOrderStatusElement to create OrderStatus element
  • method createPartiesElementBaseInfo to create Parties element
  • method createStoreElement to create Store element

  This method also creates the following child elements:

  • TotalAmount
  • OrderPlacedDate

  Parameters:

  abnOrderBaseSearchResult - The bean which contains the order information.

  aParentElement - The parent element which the Header element will build on.

  Returns:

  The Header element created.

  Throws:

  ECException

  See Also:

  TelesalesResponseBuilderImpl.createDocumentIdsElement(Element, String), createOrderStatusElement(OrderBaseSearchResultBean, Element), createPartiesElementBaseInfo(OrderBaseSearchResultBean, Element), createStoreElement(OrderBaseSearchResultBean, Element)

• createPartiesElementBaseInfo

  protected org.w3c.dom.Element createPartiesElementBaseInfo(OrderBaseSearchResultBean abnOrderBaseSearchResult,
                                                 org.w3c.dom.Element aParentElement)
                                                      throws ECException
  

  This method builds the Parties Element. This builds a brief summary of the Parties information.

  The following is a sample Parties element that indicates how the element is constructed:

  
          <oa:Parties>
                  <oa:CustomerParty>
                          <oa:Contacts>
                                  <oa:Contact>
                                          <UserAccount>
                                                  <Authorization>
                                                          <UserId>alan</UserId>
                                                  </Authorization>
                                          </UserAccount>
                                  </oa:Contact>
                          </oa:Contacts>
                  </oa:CustomerParty>
          </oa:Parties>
   
  

  Parameters:

  abnOrderBaseSearchResult - The bean which contains the order information.

  aParentElement - The parent element which the Parties Element will build on.

  Returns:

  The Parties Element created.

  Throws:

  ECException

• createBusinessElement

  protected org.w3c.dom.Element createBusinessElement(OrderBaseSearchResultBean abnOrderBaseSearchResult,
                                          org.w3c.dom.Element aParentElement)
                                               throws ECException
  

  This method builds the oa:Business Element. This builds a brief summary of the organization related information.

  The following is a sample Business element that indicates how the element is constructed:

  
                          <oa:Business> 
                                  <oa:Function>O</oa:Function>
                                  <oa:Name /> 
                                  <oa:RelatedUnit>
                                          <oa:Relationship>Parent</oa:Relationship> 
                                          <oa:Unit>
                                                  <oa:Id>-2001</oa:Id> 
                                                  <oa:Name>Root Organization</oa:Name> 
                                          </oa:Unit>
                                  </oa:RelatedUnit>
                          </oa:Business>
   
  

  Parameters:

  abnOrderBaseSearchResult - The bean which contains the order information.

  aParentElement - The parent element which the Business Element will build on.

  Returns:

  The Business Element created.

  Throws:

  ECException

• createUserdataInBusinessElement

  protected org.w3c.dom.Element createUserdataInBusinessElement(OrganizationDataBean organizationDataBean,
                                                    OrderBaseSearchResultBean abnOrderSearchResult,
                                                    org.w3c.dom.Element businessElement)
                                                         throws ECException
  

  This is an empty method to create the UserData element for Business. This could be extended by end user to add custom information in response BOD.

   ...
   Element userDataElement = createWCDocumentElement(businessElement, abnCustomerSearchResult, BodConstants.TAG_WC_USER_DATA);
   createUserDataFieldElement(userDataElement, fieldName, fieldValue);
   ...
   return userDataElement;
   
  

  Parameters:

  organizationDataBean - data bean

  abnOrderSearchResult - order search result bean

  businessElement - the business element

  Returns:

  null

  Throws:

  ECException

• createOrderCurrentChargesElement

  protected org.w3c.dom.Element createOrderCurrentChargesElement(OrderBaseSearchResultBean abnSearchResult,
                                                     org.w3c.dom.Element aParentElement)
                                                          throws ECException
  

  This method builds the OrderCurrentCharges element. This element contains following sub-elements

  • TotalCost, the total current charge,
  • TotalTax, the tax on the current charges,
  • ShippingTax, the shipping or transportation charges on the current charges,
  • DiscountAmount, the discount on the current charges,
  • TotalShipping, the shipping charge on the current charges and
  • GrandTotal, the grand current charge total

  Parameters:

  abnSearchResult - The bean which contains the order information.

  aParentElement - The parent element which the OrderCurrentCharges element will build on.

  Returns:

  The OrderCurrentCharges element created.

  Throws:

  ECException

• createOrderUnpaidBalanceElement

  protected org.w3c.dom.Element createOrderUnpaidBalanceElement(OrderBaseSearchResultBean abnSearchResult,
                                                    org.w3c.dom.Element aParentElement)
                                                         throws ECException
  

  This method builds the OrderUnpaidBalance element.

  Parameters:

  abnSearchResult - The bean which contains the order information.

  aParentElement - The parent element which the OrderUnpaidBalance element will build on.

  Returns:

  The OrderUnpaidBalance element created.

  Throws:

  ECException

• createBusinessChannelElement

  protected org.w3c.dom.Element createBusinessChannelElement(OrderBaseSearchResultBean abnSearchResult,
                                                 org.w3c.dom.Element aParentElement)
                                                      throws ECException
  

  This method creates the BusinessChannel element.

  Parameters:

  abnSearchResult - the bean which contains the order business channel information.

  aParentElement - The parent element which the BusinessChannel element will build on.

  Returns:

  The BusinessChannel element.

  Throws:

  ECException

• createAddressesElement

  protected org.w3c.dom.Element createAddressesElement(OrderBaseSearchResultBean abnOrderBaseSearchResult,
                                           java.lang.String paymentTCId,
                                           org.w3c.dom.Element aParentElement)
                                                throws ECException
  

  This method builds the Addresses element.

  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.

  Parameters:

  abnOrderBaseSearchResult - The bean which contains the billing address of the customer.

  paymentTCId - The ID of the payment TC that contains the billing address.

  aParentElement - The parent element which the Addresses element will be build on.

  Returns:

  The Addresses element created.

  Throws:

  ECException

  See Also:

  #createAddressElement(AddressAccessBean, String, Element)

• createAddressElement

  protected org.w3c.dom.Element createAddressElement(AddressAccessBean abAddress,
                                         OrderBaseSearchResultBean abnOrderBaseSearchResult,
                                         java.lang.String paymentTCId,
                                         org.w3c.dom.Element aParentElement)
                                              throws ECException
  

  This method builds the Address element.

  This method creates an Address element with the AddressId child element. Additionally it invokes the createUserdataInAddressElement(AddressAccessBean, Element) method to create the user data under Address element.

  Parameters:

  abAddress - The address access bean.

  abnOrderBaseSearchResult - search result bean

  paymentTCId - The ID of the payment TC that contains the billing address.

  aParentElement - The parent element which the Address element will be build on.

  Returns:

  The Address element created.

  Throws:

  ECException

  See Also:

  OrderBase#createUserdataInAddressElement(AddressAccessBean, Element)

• createUserdataInAddressElement

  protected org.w3c.dom.Element createUserdataInAddressElement(AddressAccessBean abAddress,
                                                   OrderBaseSearchResultBean abnOrderBaseSearchResult,
                                                   java.lang.String paymentTCId,
                                                   org.w3c.dom.Element addressElement)
                                                        throws ECException
  

  This is an empty method to create the UserData element for Address. This could be extended by end user to add custom information in response BOD.

   ...
   Element userDataElement = createWCDocumentElement(addressElement, BodConstants.TAG_WC_USER_DATA);
   createUserDataFieldElement(userDataElement, fieldName, fieldValue);
   ...
   return userDataElement;
   
  

  Parameters:

  abAddress - access bean

  abnOrderBaseSearchResult - search result bean

  paymentTCId - The ID of the payment TC that contains the billing address.

  addressElement - the address element

  Returns:

  null

  Throws:

  ECException

• createUserDataInOrderHistoryInformationElement

  protected org.w3c.dom.Element createUserDataInOrderHistoryInformationElement(OrderCommentDataBean ordCommentDataBean,
                                                                   OrderBaseSearchResultBean abnOrderBaseSearchResult,
                                                                   org.w3c.dom.Element orderHistoryInformationElement)
                                                                        throws ECException
  

  This is an empty method to create the UserData element for OrderHistory. This could be extended by end user to add custom information in response BOD.

   ...
   Element userDataElement = createWCDocumentElement(orderHistoryInformationElement, BodConstants.TAG_WC_USER_DATA);
   createUserDataFieldElement(userDataElement, fieldName, fieldValue);
   ...
   return userDataElement;
   
  

  Parameters:

  ordCommentDataBean - data bean

  abnOrderBaseSearchResult - search result bean

  orderHistoryInformationElement - history element

  Returns:

  null

  Throws:

  ECException

• createOrderBlocksElement

  protected org.w3c.dom.Element createOrderBlocksElement(OrderBaseSearchResultBean abnSearchResult,
                                             org.w3c.dom.Element aParentElement)
                                                  throws ECException
  

  This method creates the OrderBlocks element.

  This method calls the createOrderBlockElement to create the OrderBlock element.

  Parameters:

  abnSearchResult - The bean which contains the order information.

  aParentElement - The parent element which the OrderBlocks element will build on.

  Returns:

  The OrderBlocks element.

  Throws:

  ECException

• createOrderBlockElement

  protected org.w3c.dom.Element createOrderBlockElement(org.w3c.dom.Element aParentElement,
                                            com.ibm.commerce.ordermanagement.beans.OrderBlockDataBean abnOrderBlock)
                                                 throws ECException
  

  This method creates the OrderBlock element.

  The following child elements will be built:

  • BlockId
  • BlockReasonCodeId
  • Description
  • BlockedInd, the block indicator, true if blocked, false if resolved.
  • BlockDate

   <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-12 21:09:06.995</wc:BlockDate>
                  <wc:ManualBlockInd>true</wc:ManualBlockInd>
                  <UserData>    <!-- createUserdataInOrderBlockElement(OrderBlockDataBean, Element) -->
                          <UserDataField name="Name">"Value"</UserDataField>
                  <UserData/>
          </wc:OrderBlock>
   
  

  Parameters:

  aParentElement - The parent element which the OrderBlock element will build on.

  abnOrderBlock - The bean which contains the order block information.

  Returns:

  The OrderBlock element.

  Throws:

  ECException

  See Also:

  createUserdataInOrderBlockElement(OrderBlockDataBean, Element)

• createUserdataInOrderBlockElement

  protected org.w3c.dom.Element createUserdataInOrderBlockElement(com.ibm.commerce.ordermanagement.beans.OrderBlockDataBean abnOrderBlock,
                                                      org.w3c.dom.Element orderBlockElement)
                                                           throws ECException
  

  This is an empty method to create the UserData element for OrderBlock. This could be extended by end user to add custom information in response BOD.

   ...
   Element userDataElement = createWCDocumentElement(orderBlockElement, BodConstants.TAG_WC_USER_DATA);
   createUserDataFieldElement(userDataElement, fieldName, fieldValue);
   ...
   return userDataElement;
   
  

  Parameters:

  abnOrderBlock - data bean

  orderBlockElement - the order block element

  Returns:

  null

  Throws:

  ECException

• createStoreElement

  protected org.w3c.dom.Element createStoreElement(OrderBaseSearchResultBean abnOrderBaseSearchResult,
                                       org.w3c.dom.Element aParentElement)
                                            throws ECException
  

  This method creates the Store element.

  The following child elements will be built:

  • StoreId
  • Description
  • Type

   <wc:Store>
                  <wc:StoreId>10001</wc:StoreId>
                  <wc:Description>AdvancedB2BDirect</wc:Description>
                  <wc:Type>B2B</wc:Type>
   </wc:Store>
   
  

  Parameters:

  abnOrderBaseSearchResult - The bean which contains the order information.

  aParentElement - The parent element which the Store element will build on.

  Returns:

  The Store element.

  Throws:

  ECException

• setHeaderDetails

  protected void setHeaderDetails(boolean bHeaderDetails)
  

  This method set the value for getHeaderDetails parameter.

  Parameters:

  bHeaderDetails - The getHeaderDetails to set.

• setItemsDetails

  protected void setItemsDetails(boolean bItemsDetails)
  

  This method set the value for getItemsDetails parameter.

  Parameters:

  bItemsDetails - The getItemsDetails to set.

• getOrderBaseSearchResultBean

  public OrderBaseSearchResultBean getOrderBaseSearchResultBean()
  

  This method returns the current OrderBaseSearchResultBean that carries the result.

  Returns:

  returns the OrderBaseSearchResultBean.

• setOrderBaseSearchResultBean

  protected void setOrderBaseSearchResultBean(OrderBaseSearchResultBean bnOrderBaseSearchResultBean)
  

  This method sets the current OrderBaseSearchResultBean that carries the result.

  Parameters:

  bnOrderBaseSearchResultBean - the OrderBaseSearchResultBean to set.