Field Detail

• CLASSNAME

  public static final java.lang.String CLASSNAME
  

  Class Name

  See Also:

  Constant Field Values

• COPYRIGHT

  public static final java.lang.String COPYRIGHT
  

  IBM Copyright notice field

  See Also:

  Constant Field Values

Constructor Detail

• ReturnReceipt

  public ReturnReceipt()
  

Method Detail

• createReturnReceiptElement

  protected org.w3c.dom.Element createReturnReceiptElement(org.w3c.dom.Element parentElement,
                                               ReturnedProductsDataBean rtnReceipt)
                                                    throws ECException
  

  This method creates a ReturnReceipt element using the input values. This method calls the createHeaderElement(Element) and createLineElement(Element, ReturnedProductsDataBean) method to create the ReturnReceipt element. Additionally it invokes the createUserdataInReturnReceiptElement method to create the user data under ReturnReceipt element.

  Parameters:

  parentElement - the parent element

  rtnReceipt - the return receipt data bean.

  Returns:

  the ReturnReceipt element created.

  Throws:

  ECException

  See Also:

  createHeaderElement(Element), createLineElement(Element, ReturnedProductsDataBean), createUserdataInReturnReceiptElement(ReturnedProductsDataBean, Element)

• createUserdataInReturnReceiptElement

  protected org.w3c.dom.Element createUserdataInReturnReceiptElement(ReturnedProductsDataBean rtnReceipt,
                                                         org.w3c.dom.Element returnReceiptElement)
                                                              throws ECException
  

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

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

  Parameters:

  rtnReceipt - data bean

  returnReceiptElement - the return receipt element

  Returns:

  null

  Throws:

  ECException

• createLineElement

  protected void createLineElement(org.w3c.dom.Element rrElement,
                       ReturnedProductsDataBean rtnReceipt)
                            throws ECException
  

  This method creates a Line element using the input values.

  The following sample indicates the structure of the Line element and how it is constructed.

  
    <wc:Line>
       <wc:RMA_receipt_Id>100</wc:RMA_receipt_Id> <!--rtnReceipt.getDataBeanKeyReceiptId() -->
       <wc:ProductSKU>A00001006</wc:ProductSKU> <!-- rtnReceipt.getDataBeanKeyPartNumber() -->
       <wc:ProductName>Import Starter</wc:ProductName> <!-- rtnReceipt.getDataBeanKeyShortDescription() -->
       <wc:QuantityReturned>1</wc:QuantityReturned> <!-- rtnReceipt.getDataBeanKeyTotalQuantity()-->
       <wc:QuantityDisposed>1</wc:QuantityDisposed> <!-- rtnReceipt..getDataBeanKeyNonDispositionQuantity()-->
             <wc:DateReceived>2004-10-20 13:04:46.108</wc:DateReceived> <!-- rtnReceipt.getDataBeanKeyNonDispositionQuantity() -->
    </wc:Line>
  
   
  

  Parameters:

  rrElement - the parent element

  rtnReceipt - databean carrying the receipt data

  Throws:

  ECException

• createHeaderElement

  protected void createHeaderElement(org.w3c.dom.Element returnElement)
                              throws ECException
  

  This method creates a Header element using the input values.

  The following sample indicates the structure of the Header element and how it is constructed.

  
    <wc:Header>
       <wc:RMA_Id>100</wc:RMA_Id> <!-- getRmaId() -->
    </wc:Header>
  
   
  

  Parameters:

  returnElement - parent return element.

  Throws:

  ECException

• getRmaId

  protected java.lang.String getRmaId()
  

  This method gets the rma id.

  Returns:

  rmaId. This method returns always null.