Field Detail

• CLASSNAME

  public static final java.lang.String CLASSNAME
  

  Define the CLASSNAME. Value is "com.ibm.commerce.telesales.messaging.bodreply.TelesalesResponseBuilderImpl".

  See Also:

  Constant Field Values

• COPYRIGHT

  public static final java.lang.String COPYRIGHT
  

  IBM Copyright notice field

  See Also:

  Constant Field Values

• DEFAULT_DOCUMENT_FIELD_VALUE

  public static final java.lang.String DEFAULT_DOCUMENT_FIELD_VALUE
  

  The default value for document element field.

• iRootElement

  protected org.w3c.dom.Element iRootElement
  

  The iRootElement contains the response document's root element. It is initialized by the createRootDocumentElement method.

• iApplicationAreaElement

  protected org.w3c.dom.Element iApplicationAreaElement
  

  The iApplicationAreaElement contains the response document's ApplicationArea element. It is initialized by the createApplicationAreaElement method.

• iCommerceAreaElement

  protected org.w3c.dom.Element iCommerceAreaElement
  

  The iCommerceAreaElement contains the response document's CommerceArea element. It is initialized by the createCommerceElement method.

• iOriginalApplicationAreaElement

  protected org.w3c.dom.Element iOriginalApplicationAreaElement
  

  The iOriginalApplicationAreaElement contains the response document's originalApplicationArea element. It is initialized by the createOriginalApplicationAreaElement method.

• iDataAreaElement

  protected org.w3c.dom.Element iDataAreaElement
  

  The iDataAreaElement contains the response document's DataArea element. It is initialized by the buildDataArea method.

• iBodElement

  protected org.w3c.dom.Element iBodElement
  

  The iBodElement contains the response document's BOD element.

• iBodHeaderElement

  protected org.w3c.dom.Element iBodHeaderElement
  

  The iBodHeaderElement contains the response document's BODHeader element.

• iNounOutcomeElement

  protected org.w3c.dom.Element iNounOutcomeElement
  

  The iNounOutcomeElement contains the response document's NounOutcome element. It is initialized by the createNounOutcomeElement method.

• iSearchTypeMappings

  protected java.util.HashMap iSearchTypeMappings
  

  This contains the mappings between the search type obtained from the SelectExpression element in the request Business Object Document to the actual value needed by the OrderListBean search databean. The search type is the key to the table. This is the search type obtained from the SelectExpression element. The value of the table is the actual value needed by the search bean.

• DEFAULT_SEARCH_TYPE_VALUE

  public java.lang.String DEFAULT_SEARCH_TYPE_VALUE
  

  The default value for the search type value.

Constructor Detail

• TelesalesResponseBuilderImpl

  public TelesalesResponseBuilderImpl()
  

Method Detail

• init

  public void init(CommandContext aCmdCtxt,
          TypedProperty aRequestProperties,
          TypedProperty aResponseProperties,
          org.w3c.dom.Document aRequestBOD,
          org.w3c.dom.Document aResponseBOD)
  

  Initialize the necessary parameters before starting building the response Business Object Document.

  This method also retrieve the task name from the request Business Object Document and sets the task name.

  Specified by:

  init in interface ITelesalesResponseBuilder

  Parameters:

  aCmdCtxt - the commandContext sent by the client.

  aRequestProperties - the request properties sent by the client.

  aResponseProperties - the response properties sent by the client.

  aRequestBOD - the request Business Object Document sent by the client.

  aResponseBOD - the respond Business Object document needs to be built.

• createWCDocumentElement

  protected org.w3c.dom.Element createWCDocumentElement(org.w3c.dom.Element aParentElement,
                                            java.lang.String astrElementName,
                                            java.lang.String astrValue)
  

  Convenience method that creates a new element for the response document iXmlDoc and WebSphere Commerce namespace URL. This method calls the method createDocumentElementNS(String, Element, String, String) to create the document element.

  Parameters:

  aParentElement - The parent element of this new element.

  astrElementName - The tag name of this new element.

  astrValue - Text that should be appended as a child to this node.

  Returns:

  The new element.

  See Also:

  createDocumentElementNS(String, Element, String, String)

• createWCDocumentElement

  protected org.w3c.dom.Element createWCDocumentElement(org.w3c.dom.Element aParentElement,
                                            java.lang.String astrElementName)
  

  Convenience method that creates a new element for the response document iXmlDoc and WebSphere Commerce namespace URL. This method calls the method createDocumentElementNS(String, Element, String) to create the document element.

  Parameters:

  aParentElement - The parent element for this new element.

  astrElementName - The tag name of this new element.

  Returns:

  The new element

  See Also:

  createDocumentElementNS(String, Element, String)

• createOADocumentElement

  protected org.w3c.dom.Element createOADocumentElement(org.w3c.dom.Element aParentElement,
                                            java.lang.String astrElementName,
                                            java.lang.String astrValue)
  

  Convenience method that creates a new element for the response document iXmlDoc and OAGIS namespace URL. This method calls the method createDocumentElementNS(String, Element, String, String) to create the document element.

  Parameters:

  aParentElement - The parent element of this new element.

  astrElementName - The tag name of this new element.

  astrValue - Text that should be appended as a child to this node.

  Returns:

  The new element.

  See Also:

  createDocumentElementNS(String, Element, String, String)

• createOADocumentElement

  protected org.w3c.dom.Element createOADocumentElement(org.w3c.dom.Element aParentElement,
                                            java.lang.String astrElementName)
  

  Convenience method that creates a new element for the response document iXmlDoc and OAGIS namespace URL. This method calls the method createDocumentElementNS(String, Element, String) to create the document element.

  Parameters:

  aParentElement - The parent element for this new element.

  astrElementName - The tag name of this new element.

  Returns:

  The new element

  See Also:

  createDocumentElementNS(String, Element, String)

• createDocumentElementNS

  protected org.w3c.dom.Element createDocumentElementNS(java.lang.String astrNameSpace,
                                            org.w3c.dom.Element aParentElement,
                                            java.lang.String astrElementName,
                                            java.lang.String astrValue)
  

  Convenience method that creates a new element for the response document iXmlDoc and a given namespace URI.

  Parameters:

  astrNameSpace - The namespace URI of the element to create.

  aParentElement - The parent element of this new element.

  astrElementName - The tag name of this new element.

  astrValue - Text that should be appended as a child to this node.

  Returns:

  The new element.

  See Also:

  createDocumentElementNS(String, Element, String)

• createDocumentElementNS

  protected org.w3c.dom.Element createDocumentElementNS(java.lang.String astrNameSpace,
                                            org.w3c.dom.Element aParentElement,
                                            java.lang.String astrElementName)
  

  This method creates a new element under the specified parent element for the response document iXmlDoc with a given namespace URI.

   Usage example:
                  createDocumentElementNS(BodConstants.XML_WC_NAMESPACE, parentElement, "wc:newElementName")
   
  

  Parameters:

  astrNameSpace - The namespace URI of the new element to create.

  aParentElement - The parent element for this new element.

  astrElementName - The tag name of this new element.

  Returns:

  The new element

  See Also:

  BodConstants.XML_WC_NAMESPACE, BodConstants.XML_OAGIS_NAMESPACE, createRootDocumentElement(String)

• getNumberFormat

  protected com.ibm.icu.text.NumberFormat getNumberFormat()
  

  Returns the NumberFormat to be used to format a number. This method uses the Locale obtained from the current command context to get the NumberFormat.

  Returns:

  the NumberFormat to be used to format a number.

• createWCDocumentElement

  protected org.w3c.dom.Element createWCDocumentElement(org.w3c.dom.Element parentElement,
                                            java.lang.String elementName,
                                            java.math.BigDecimal value)
  

  Convenience method that creates a new element for the response document iXmlDoc and WebSphere Commerce namespace URL.

  This method calls the method getNumberFormat to get the correct NumberFormat to format the input parameter value.

  It also calls the createWCDocumentElement(Element, String, String) to create the document element.

  Parameters:

  parentElement - The parent element for this new element.

  elementName - The tag name of this new element.

  value - Text that should be appended as a child to this node.

  Returns:

  The new element.

  See Also:

  getNumberFormat(), createWCDocumentElement(Element, String, String)

• createWCDocumentElement

  protected org.w3c.dom.Element createWCDocumentElement(org.w3c.dom.Element parentElement,
                                            java.lang.String elementName,
                                            java.lang.Long value)
  

  Convenience method that creates a new element for the response document iXmlDoc and WebSphere Commerce namespace URL.

  This method calls the method getNumberFormat to get the correct NumberFormat to format the input parameter value.

  It also calls the createWCDocumentElement(Element, String, String) to create the document element.

  Parameters:

  parentElement - The parent element for this new element.

  elementName - The tag name of this new element.

  value - Text that should be appended as a child to this node.

  Returns:

  The new element.

  See Also:

  getNumberFormat(), createWCDocumentElement(Element, String, String)

• createRootDocumentElement

  protected org.w3c.dom.Element createRootDocumentElement(java.lang.String astrRootElementName)
  

  Creates the root element.

  This method calls the following methods to create the attribute of the root element.

  • setNameSpaceAttributesForRootDocumentElement
  • setSchemaInstanceAttributeForRootDocumentElement
  • setSchemaLocationAttributeForRootDocumentElement
  • setGeneralAttributesForRootDocumentElement

  Parameters:

  astrRootElementName - Name of the root element.

  Returns:

  the root element created.

• setNameSpaceAttributesForRootDocumentElement

  protected org.w3c.dom.Element setNameSpaceAttributesForRootDocumentElement(org.w3c.dom.Element aRootElement)
  

  Sets the name space attributes for the given root document element.

  Here is what is being set:

   xmlns:wc="http://www.ibm.com/WebsphereCommerce/Telesales/oagis"
   xmlns:oa="http://www.openapplications.org/oagis"
   
  

  Parameters:

  aRootElement - the root document element which the attribute is being set.

  Returns:

  the root document element.

  See Also:

  BodConstants.ATT_WC_NAMESPACE, BodConstants.ATT_OAGIS_NAMESPACE

• setSchemaLocationAttributeForRootDocumentElement

  protected org.w3c.dom.Element setSchemaLocationAttributeForRootDocumentElement(org.w3c.dom.Element aRootElement,
                                                                     java.lang.String astrRootElementName)
  

  Sets the schema location attributes for the given root document element.

  Here is what is being set:

   xsi:schemaLocation="http://www.ibm.com/WebsphereCommerce/Telesales/oagis
   ../BODs/ConfirmSalesOrder.xsd">
   
  

  Parameters:

  aRootElement - the root document element which the attribute is being set.

  astrRootElementName - the tag name of the root element.

  Returns:

  the root document element.

  See Also:

  BodConstants.ATT_SCHEMA_LOCATION

• setSchemaInstanceAttributeForRootDocumentElement

  protected org.w3c.dom.Element setSchemaInstanceAttributeForRootDocumentElement(org.w3c.dom.Element aRootElement)
  

  Sets the schema instance attributes for the given root document element.

  Here is what is being set:

   xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
   
  

  Parameters:

  aRootElement - the root document element which the attribute is being set.

  Returns:

  the root document element.

• setGeneralAttributesForRootDocumentElement

  protected org.w3c.dom.Element setGeneralAttributesForRootDocumentElement(org.w3c.dom.Element aRootElement)
  

  Sets the general attributes for the given root document element.

  Here is what is being set:

   environment="Test" lang="en-US" revision="8.1" version="8.1"
   
  

  Parameters:

  aRootElement - the root document element which the attribute is being set.

  Returns:

  the root document element.

• createBodFailureElement

  protected org.w3c.dom.Element createBodFailureElement(org.w3c.dom.Element aParentElement,
                                            java.lang.String astrReasonCode,
                                            java.lang.String astrDescription)
                                                 throws ECException
  

  Builds the BODFailure element under the BODHeader element.

  The following is an example of BODFailure element:

  
   <BODFailure> <ErrorMessage> <Description> CMN3101E The
   system is unavailable due to "java.lang.ArithmeticException: Rounding
   necessary". </Description>
   <ReasonCode>0000</ReasonCode> </ErrorMessage>
   </BODFailure>
  
   
  

  Parameters:

  aParentElement - the parent element for this new element

  astrReasonCode - the reason code of the failure.

  astrDescription - the message description of the failure.

  Returns:

  the BODFailure element created.

  Throws:

  ECException

• createNounOutcomeFailureElement

  protected org.w3c.dom.Element createNounOutcomeFailureElement(org.w3c.dom.Element aParentElement,
                                                    java.lang.String astrReasonCode,
                                                    java.lang.String astrDescription)
                                                         throws ECException
  

  Builds the NounOutcome element under the BOD element for an error or failure. This method calls createNounFailureElement.

  Here is an example of the NounOutcome element:

  
     <NounOutcome>
          <oa:NounFailure>
                  <oa:ErrorMessage>
                          <oa:Description>
                                  CMN3101E The system is unavailable due to "java.lang.ArithmeticException: Rounding necessary".
                          </oa:Description>
                          <oa:ReasonCode>0000</oa:ReasonCode>
                  </oa:ErrorMessage>
          </oa:NounFailure>
     </NounOutcome>
  
  
   
  

  Parameters:

  aParentElement - the parent element for this new element

  astrDescription - the error message description.

  astrReasonCode - the error reason code.

  Returns:

  the NounOutcome element created.

  Throws:

  ECException

• createNounFailureElement

  protected org.w3c.dom.Element createNounFailureElement(org.w3c.dom.Element aParentElement,
                                             java.lang.String astrReasonCode,
                                             java.lang.String astrDescription)
                                                  throws ECException
  

  Builds the NounFailure element under the NounOutcome element for an error or failure.

  Here is an example of the NounFailure element:

  
    <oa:NounFailure>
          <oa:ErrorMessage>
                  <oa:Description>
                          CMN3101E The system is unavailable due to "java.lang.ArithmeticException: Rounding necessary".
                  </oa:Description>
                  <oa:ReasonCode>0000</oa:ReasonCode>
          </oa:ErrorMessage>
    </oa:NounFailure>
  
  
   
  

  Parameters:

  aParentElement - the parent element for this new element

  astrDescription - the error message description.

  astrReasonCode - the error reason code.

  Returns:

  the NounOutcome element created.

  Throws:

  ECException

• createApplicationAreaElement

  protected org.w3c.dom.Element createApplicationAreaElement()
                                                      throws ECException
  

  Builds the ApplicationArea element. The ApplicationArea element is stored in iApplicationAreaElement and appended as a child of the root element of the response document. This method calls the method createSenderElement to create the Sender child element.

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

  
    <oa:ApplicationArea>
       <oa:Sender> <!-- created by the createSenderElementForApplicationArea method -->
          .
          .
          .
       </oa:Sender>
       <oa:CreationDateTime>2004-08-11T08:09:15</oa:CreationDateTime> <!-- current time -->
       <oa:Signature qualifyingAgency=""/>
       <oa:BODId>2004-08-11T08:09:15[wcsadmin]client1</oa:BODId> <!-- time/userid/hostname -->
       <oa:UserArea/>
    </oa:ApplicationArea>
  
   
  

  Returns:

  the ApplicationArea element

  Throws:

  ECException

• createCommerceAreaElement

  protected org.w3c.dom.Element createCommerceAreaElement(org.w3c.dom.Element aParentElement)
                                                   throws ECException
  

  Builds the CommerceArea element. The element is stored in iCommerceAreaElement.

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

  
    <CommerceArea>
       <StoreId>0</StoreId>
       <LanguageId>0</LanguageId>
    </CommerceArea>
  
   
  

  Parameters:

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

  Returns:

  the CommerceArea element created.

  Throws:

  ECException

• createOriginalApplicationAreaElement

  protected org.w3c.dom.Element createOriginalApplicationAreaElement(org.w3c.dom.Element aParentElement)
                                                              throws ECException
  

  Builds the OriginalApplicationArea element.

  The OriginalApplicationArea element is stored in iOriginalApplicationAreaElement and appended as a child of the parent element.

  This method will get all the children and grand children of the application area in the request BOD. And builds the sub tress of the original application area in the response BOD.

  Parameters:

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

  Returns:

  the ApplicationArea element.

  Throws:

  ECException

• createSenderElementForApplicationArea

  protected org.w3c.dom.Element createSenderElementForApplicationArea()
                                                               throws ECException
  

  Builds the Sender element for the ApplicationArea element. This methods calls the createSenderElement method.

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

  
  
          <oa:Sender>
                  <oa:LogicalId>COMMERCE</oa:LogicalId>
                  <oa:Component>Quote</oa:Component>                  <!-- value determined by the determineComponent() method of TelesalesResponseUtil -->
                  <oa:Task>UpdateQuoteResponse</oa:Task>                      
                  <oa:ReferenceId>-5003857217700440077</oa:ReferenceId>       <!-- value determined by the determineReferenceID() method of TelesalesResponseUtil -->
                  <oa:Confirmation>0</oa:Confirmation>                        
                  <oa:AuthorizationId>LOGON_TOKEN_ID_SCAFFOLDING</oa:AuthorizationId>         <!-- value determined by the determineAuthorizationID() method of TelesalesResponseUtil -->
          </oa:Sender>
  
  
   
  

  Returns:

  the Sender element created.

  Throws:

  ECException

• createSenderElement

  protected org.w3c.dom.Element createSenderElement(org.w3c.dom.Element aParentElement,
                                        java.lang.String astrLogicalId,
                                        java.lang.String astrComponentName,
                                        java.lang.String astrTaskName,
                                        java.lang.String astrConfirmation,
                                        java.lang.String astrReferenceID,
                                        java.lang.String astrAuthorizationID)
                                             throws ECException
  

  Builds the Sender element for the parent element provided.

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

  
  
  
          <oa:Sender>
                  <oa:LogicalId>COMMERCE</oa:LogicalId>               
                  <oa:Component>Order</oa:Component>                  
                  <oa:Task>UpdateOrder</oa:Task>
                  <oa:ReferenceId>-5003857217700440077</oa:ReferenceId>               
                  <oa:Confirmation>0</oa:Confirmation>                
                  <oa:AuthorizationId>LOGON_TOKEN_ID_SCAFFOLDING</oa:AuthorizationId>         
          </oa:Sender>
  
  
  
   
  

  Parameters:

  aParentElement - the parent element of the Sender element.

  astrLogicalId - the value of the LogicalId element.

  astrComponentName - the value of Component element.

  astrTaskName - the value of the Task element.

  astrConfirmation - the value of the Confirmation element.

  astrReferenceID - the value of the ReferenceId element.

  astrAuthorizationID - the value of the AuthorizationID element.

  Returns:

  the Sender element created.

  Throws:

  ECException

• createBodSuccessElement

  protected org.w3c.dom.Element createBodSuccessElement(org.w3c.dom.Element aParentElement)
                                                 throws ECException
  

  Creates the BODSuccess element.

  Parameters:

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

  Returns:

  the BODSuccess element created.

  Throws:

  ECException

• createDocumentIdsElement

  protected org.w3c.dom.Element createDocumentIdsElement(org.w3c.dom.Element aParentElement,
                                             java.lang.String astrDocumentId)
                                                  throws ECException
  

  Creates the DocumentIds element for the given parent element and document Id. This will create the child element DocumentId.

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

                  <oa:DocumentIds>
                          <oa:DocumentId>
                                  <oa:Id>19502</oa:Id>
                          </oa:DocumentId>
                  </oa:DocumentIds>
   
  

  Parameters:

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

  astrDocumentId - the value of the Id element.

  Returns:

  the DocumentIds element created.

  Throws:

  ECException

• createNounOutcomeElement

  protected org.w3c.dom.Element createNounOutcomeElement(org.w3c.dom.Element aParentElement,
                                             java.lang.String astrDocumentId)
                                                  throws ECException
  

  Creates the NounOutcome element for the given parent element and document Id. This method calls the createDocumentIdsElement to create the DocumentIds element.

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

  
                  <NounOutcome>
                          <oa:DocumentIds>          <!-- created by the createDocumentIdsElement method -->
                                  .
                                  .
                                  .
                          </oa:DocumentIds>
                          <oa:NounSuccess/>
                          <oa:UserArea/>
                  </NounOutcome>
  
   
  

  Parameters:

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

  astrDocumentId - the document id value will be passed to createDocumentIdsElement method to create the DocumentIds element.

  Returns:

  the NounOutcome element created.

  Throws:

  ECException

• createNounSuccessElement

  protected org.w3c.dom.Element createNounSuccessElement(org.w3c.dom.Element aParentElement)
                                                  throws ECException
  

  Creates the NounSuccess element for the given parent element. By default this implementation just creates an element with no children.

  Parameters:

  aParentElement - the parent element for this new element.

  Returns:

  the NounSuccess element created.

  Throws:

  ECException

• createUserAreaElement

  protected org.w3c.dom.Element createUserAreaElement(org.w3c.dom.Element aParentElement)
                                               throws ECException
  

  Creates the UserArea element for the given parent element. By default this implementation just creates an element with no children.

  Parameters:

  aParentElement - the parent element for this new element.

  Returns:

  the NounOutcome element created.

  Throws:

  ECException

• createNounOutcomeElement

  protected org.w3c.dom.Element createNounOutcomeElement(org.w3c.dom.Element aParentElement)
                                                  throws ECException
  

  Creates the NounOutcome element. This method returns null. Any sub-class needs to construct the NounOutcome element needs to override this method to provide its own implementations.

  Parameters:

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

  Returns:

  the NounOutcome element created.

  Throws:

  ECException

• createPartyIdElement

  protected org.w3c.dom.Element createPartyIdElement(java.lang.String aStrValue,
                                         org.w3c.dom.Element aParentElement)
  

  Builds the PartyId element. This also creates the child element Id.

  Parameters:

  aStrValue - the value of the Id element.

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

  Returns:

  the PartyId element created.

• buildSuccessElement

  protected void buildSuccessElement()
                              throws ECException
  

  Builds the BODSuccess and NounOutcome element payload of the Business Object Document. This method calls the method createBodSuccessElement to create the BODSuccess element. This method calls the method createNounOutcomeElement to create the NounOutcome element.

  Throws:

  ECException

• createUserDataFieldElement

  protected org.w3c.dom.Element createUserDataFieldElement(org.w3c.dom.Element aParentElement,
                                               java.lang.String astrName,
                                               java.lang.String astrValue)
                                                    throws ECException
  

  Builds the UserDataField element.

  Parameters:

  aParentElement - the parent element which the UserDataField element builds on.

  astrName - the name of the user data field.

  astrValue - the value which is corresponding to the name.

  Returns:

  the UserDataField element created.

  Throws:

  ECException

• createUserDataElement

  protected org.w3c.dom.Element createUserDataElement(SearchResultBean aSearchResultBean,
                                          org.w3c.dom.Element aParentElement)
                                               throws ECException
  

  Creates the UserData element. This method calls createUserDataFieldElement to construct child elements for every name value pair found in the user data map in the search result bean.

  Parameters:

  aSearchResultBean - search result bean

  aParentElement - the parent element

  Returns:

  the UserData element

  Throws:

  ECException

• buildResultArea

  protected void buildResultArea()
                          throws ECException
  

  Builds the Result specific section of the Business Object Document. This may include a success or failure portion.

  Throws:

  ECException

• buildConfirmDataArea

  protected void buildConfirmDataArea()
                               throws ECException
  

  Builds the Confirm BOD DataArea.

  This calls the method createOriginalApplicationAreaElement to build the OriginalApplicationArea section of the DataArea.

  Throws:

  ECException

• buildFailureElement

  protected void buildFailureElement()
                              throws ECException
  

  Builds the BOD elements when an error or exception occurred. This method will build the BODFailure and NounOutcome of the Confirm BOD.

  Throws:

  ECException

• returnEmptyStringIfNull

  protected static java.lang.String returnEmptyStringIfNull(java.lang.String inputString)
  

  Returns an empty string if the input string is null.

  Parameters:

  inputString - the input string.

  Returns:

  the inputString itself if it is not null, BodConstants.VAL_EMPTY otherwise.

  See Also:

  BodConstants.VAL_EMPTY

• getRequestProperties

  protected TypedProperty getRequestProperties()
  

  Gets the request properties.

  Returns:

  TypedProperty the request properties.

• getResponseProperties

  protected TypedProperty getResponseProperties()
  

  Gets the response properties.

  Returns:

  TypedProperty the response properties.

• getRequestBod

  protected org.w3c.dom.Document getRequestBod()
  

  Gets the request Business Object Document.

  Returns:

  the request Business Object Document.

• getCmdCtxt

  protected CommandContext getCmdCtxt()
  

  Gets the command context.

  Returns:

  the command context.

• getDocumentRoot

  protected org.w3c.dom.Element getDocumentRoot()
  

  Gets the root of the response Business Object Document.

  Returns:

  the root of the response Business Object Document.

• setRequestBod

  protected void setRequestBod(org.w3c.dom.Document reqBodToSet)
  

  Sets the request Business Object Document.

  Parameters:

  reqBodToSet - the request Business Object Document value to be set.

• getResponseBod

  protected org.w3c.dom.Document getResponseBod()
  

  Gets the response Business Object Document.

  Returns:

  the response Business Object Document.

• getTaskName

  protected java.lang.String getTaskName()
  

  Gets the task name from the request Business Object Document.

  Returns:

  The task name value to be set.

• buildResponse

  public java.lang.String buildResponse()
                                 throws ECException
  

  Constructs the response Business Object Document.

  • Invokes the method buildApplicationArea to build the ApplicationArea section of the document.
  • Invokes method buildDataArea to construct the DataArea section of this Business Object Document.

  Specified by:

  buildResponse in interface ITelesalesResponseBuilder

  Returns:

  the response BOD. If isResponseWrapWithCDATAElement() method returns true, it will call getResponseBusinessObjectDocumentWithCDATA method to wrap the response using CDATA element and returns the same.

  Throws:

  ECSystemException

  ECException

• getResponseBusinessObjectDocumentWithCDATA

  protected java.lang.String getResponseBusinessObjectDocumentWithCDATA(java.lang.String responseObject)
  

  This method is used to wrap the XML response with CDATA element. Using this the response will not be encoded.

  Parameters:

  responseObject -

  Returns:

  responseObject wrapped with CDATA. If response is my repsonse , retun value would be <xml>my response </xml> .

• isResponseWrapWithCDATAElement

  protected boolean isResponseWrapWithCDATAElement()
  

  This method is used to confirm whether response should be wrapped using CDATA or not. Default implemention returns true. Customer may override this method.

  Returns:

  true

• printDOM

  public static void printDOM(org.w3c.dom.Node aNode,
              java.io.FileWriter aFileWriter)
  

  Prints the given node and its children for debugging purpose.

  Parameters:

  aNode - the node to be printed.

  aFileWriter - file writer

• buildApplicationArea

  protected void buildApplicationArea()
                               throws ECException
  

  Creates the root document element and Builds the ApplicationArea section of the document. This method calls the method createRootDocumentElement to create the root document element. This method calls the method createApplicationAreaElement to create the ApplicationArea element.

  Throws:

  ECException

  See Also:

  createRootDocumentElement(String), createApplicationAreaElement()

• buildDataArea

  protected abstract void buildDataArea()
                                 throws ECException
  

  Builds the DataArea of the response document. The response builder needs to provide its own implementations.

  Throws:

  ECException

• getRootElementName

  protected abstract java.lang.String getRootElementName()
  

  Gets the root element name of the response document. The response builder needs to provide its own implementations.

  Returns:

  the root element name.

• getSearchCriteria

  protected SearchCriteria getSearchCriteria(org.w3c.dom.Document aRequestBod)
  

  Gets the search criteria from the request Business Object Document.

  Parameters:

  aRequestBod - the request Business Object Document.

  Returns:

  the search criteria.

• unmarshallDataArea

  protected void unmarshallDataArea(SearchCriteria aSearchCriteria,
                        org.w3c.dom.Node aNode,
                        java.lang.String astrNoun)
  

  Unmarshall the DataArea element of the given document node and use the data to populate the given search criteria.

  Parameters:

  aSearchCriteria - the search criteria need to be populated.

  aNode - the document node.

  astrNoun - the value of the Noun stored in the DataArea.

• unmarshallGet

  protected void unmarshallGet(SearchCriteria searchCriteria,
                   org.w3c.dom.Node node)
  

  Unmarshall the Get element of the given document node and use the data to populate the given search criteria.

  Parameters:

  searchCriteria - the customer search criteria.

  node - the document node.

• unmarshallNoun

  protected void unmarshallNoun(org.w3c.dom.Node node)
  

  Unmarshall the Noun element of the given document node. The Noun element can be Customer,SalesOrder and so forth.

  Parameters:

  node - the document node.

• unmarshallCommerceArea

  protected void unmarshallCommerceArea(org.w3c.dom.Node node)
  

  Unmarshall the CommerceArea element of the given document node. This method also gets the store id from the document node and sets the store id in the command context.

  Parameters:

  node - the document node.

• unmarshallReturnCriteria

  protected void unmarshallReturnCriteria(SearchCriteria aSearchCriteria,
                              org.w3c.dom.Node node)
  

  Unmarshall the ReturnCriteria element of the given document node and use the data to populate the given customer search criteria.

  Parameters:

  aSearchCriteria - the customer search criteria.

  node - the document node.

• unmarshallTextNode

  protected java.lang.String unmarshallTextNode(org.w3c.dom.Node textNode)
  

  Unmarshall a given text node.

  Parameters:

  textNode - the text node.

  Returns:

  the value of the text node.

• initializeSearchTypeMapping

  protected void initializeSearchTypeMapping()
  

  Initialize the mapping between the search type values and the search types.

  See Also:

  initializeDefaultSearchTypeMapping(Map)

• initializeDefaultSearchTypeMapping

  public void initializeDefaultSearchTypeMapping(java.util.Map searchTypeMappings)
  

  Initialize the specified map with the default search values and search types.

  The following types are initialized with values given on right hand side.

          BodConstants.KEY_RETRIEVE_ALL                   BodConstants.VAL_RETRIEVE_ALL
          BodConstants.KEY_MATCH_CASE_BEGIN               BodConstants.VAL_MATCH_CASE_BEGIN
          BodConstants.KEY_MATCH_CASE_CONTAIN             BodConstants.VAL_MATCH_CASE_CONTAIN
          BodConstants.KEY_IGNORE_CASE_BEGIN              BodConstants.VAL_IGNORE_CASE_BEGIN
          BodConstants.KEY_IGNORE_CASE_CONTAIN            BodConstants.VAL_IGNORE_CASE_CONTAIN
          BodConstants.KEY_MATCH_CASE_EXACT_MATCH         BodConstants.VAL_MATCH_CASE_EXACT_MATCH
          BodConstants.KEY_IGNORE_CASE_EXACT_MATCH        BodConstants.VAL_IGNORE_CASE_EXACT_MATCH
   
  

  Parameters:

  searchTypeMappings - search type map

  See Also:

  BodConstants.KEY_RETRIEVE_ALL, BodConstants.VAL_RETRIEVE_ALL, BodConstants.KEY_MATCH_CASE_BEGIN, BodConstants.VAL_MATCH_CASE_BEGIN, BodConstants.KEY_MATCH_CASE_CONTAIN, BodConstants.VAL_MATCH_CASE_CONTAIN, BodConstants.KEY_IGNORE_CASE_BEGIN, BodConstants.VAL_IGNORE_CASE_BEGIN, BodConstants.KEY_IGNORE_CASE_CONTAIN, BodConstants.VAL_IGNORE_CASE_CONTAIN, BodConstants.KEY_MATCH_CASE_EXACT_MATCH, BodConstants.VAL_MATCH_CASE_EXACT_MATCH, BodConstants.KEY_IGNORE_CASE_EXACT_MATCH, BodConstants.VAL_IGNORE_CASE_EXACT_MATCH

• getDefaultSearchTypeValue

  protected java.lang.String getDefaultSearchTypeValue(java.lang.String astrSearchType)
  

  Returns the search type value for the given search type. If the search type is not found in the mapping, an empty string will be returned.

  Parameters:

  astrSearchType - the search type.

  Returns:

  the search type value.

• getSearchTypeValue

  protected java.lang.String getSearchTypeValue(java.lang.String astrSearchType)
  

  Returns the search type value for the given search type. If the search type is not found in the mapping, an empty string will be returned.

  Parameters:

  astrSearchType - the search type.

  Returns:

  the search type value.

• getTagNameWithoutNameSpace

  protected java.lang.String getTagNameWithoutNameSpace(java.lang.String astrName)
  

  Gets the local name of the given tag name.

  This method assumes that the namespace is a prefix of the given tag name and the character ':' is a separator between namespace and the actual tag name. For example, the name space of the given tag name 'Order:OrderItem' is 'Order', and 'OrderItem' is the tag name returned by this method.

  If separator ':' is not present in the input string astrName, the same input string is returned.

  Parameters:

  astrName - tag name

  Returns:

  the tag without the namespace

  See Also:

  BodConstants.NAME_SPACE_AND_TAG_LOCAL_NAME_SEPARATOR

• findNodeWithLocalName

  protected org.w3c.dom.Node findNodeWithLocalName(org.w3c.dom.Node aNode,
                                       java.lang.String astrName)
  

  Finds the corresponding Node with the given name in the Document.

  • This method will first remove the name space from the input name using the method getTagNameWithoutNameSpace and use the local name to find the node with the same local name.
  • Method accepts two arguments, a reference to the parent or reference Node to start the search from and the node name.
  • Traverses the document tree in a recursive fashion looking for the node and returns the Node on first match.
  • If node not found, it returns null

  Parameters:

  aNode - reference Node as the starting point to search

  astrName - name of the Node being searched

  Returns:

  the node associated with the name

• getElementValueByLocalName

  protected java.lang.String getElementValueByLocalName(org.w3c.dom.Node aNode,
                                            java.lang.String astrParentTagName,
                                            java.lang.String astrName)
  

  Finds the corresponding element node value with the given name and parent tag name in the Document.

  • This method will first remove the name space from the input name and parent tag name using the method getTagNameWithoutNameSpace and use the local name to find the node with the same local name and parent node local name.
  • Method accepts two arguments, a reference to the parent or reference Node to start the search from and the node name.
  • Traverses the document tree in a recursive fashion looking for the node and returns the node value on first match.
  • If node not found, it returns null.

  Parameters:

  aNode - reference Node as the starting point to search.

  astrParentTagName - the name of the parent node.

  astrName - name of the node being searched.

  Returns:

  the value corresponding to the element node or an empty string.

• getElementAttributeValueByLocalName

  protected java.lang.String getElementAttributeValueByLocalName(org.w3c.dom.Node aNode,
                                                     java.lang.String astrTagname,
                                                     java.lang.String astrAttributeName)
  

  Finds the corresponding element node attribute value with the given node name and attribute name in the Document.

  • This method will first call the method findNodeWithLocalName to use the local name to find the node with the same local name and parent node local name.
  • If the node is found, it will try to find the attribute value for the given attribute name.
  • If the attribute is not found, it returns an empty string.

  Parameters:

  aNode - the reference to the parent or reference Node to start the search from.

  astrTagname - the tag name of the node.

  astrAttributeName - name of the attribute

  Returns:

  the value corresponding to the element node or an empty string.

• determineRequestReferenceID

  protected java.lang.String determineRequestReferenceID()
  

  Determine the reference Id in the Sender element under ApplicationArea of the request BOD

  Returns:

  the reference id.

• determineRequestAuthorizationID

  protected java.lang.String determineRequestAuthorizationID()
  

  Determine the authorization Id in the Sender element under ApplicationArea of the request BOD

  Returns:

  the authorization Id.

• determineRequestLogonID

  protected java.lang.String determineRequestLogonID()
  

  Determine the logon ID of the request.

  Returns:

  the logon id.

• determineRequestMachineName

  protected java.lang.String determineRequestMachineName()
  

  Determine the machine name in the BODId element under ApplicationArea of the request BOD.

  Returns:

  the machine name in the Application area of the request BOD.

• getDateTime

  protected java.lang.String getDateTime(java.lang.String astrFormat)
  

  Gets the current date or time in the requested format.

  Parameters:

  astrFormat - desired format (for example yyyy:MM:dd, h:mm a)

  Returns:

  current date

• determineRequestComponent

  protected java.lang.String determineRequestComponent()
  

  Determine the component in the Sender element under ApplicationArea of the request BOD

  Returns:

  the component name.

• determineMessageId

  protected java.lang.String determineMessageId()
  

  Determine the message id when error occurred.

  Returns:

  the message id. if KEY_ERROR_CODE is exist in request properties.

• formatNumeric

  public java.lang.String formatNumeric(java.lang.Double amount)
  

  Formats the Double numeric value in a locale-independent manner.

  Parameters:

  amount - The Double value.

  Returns:

  The formatted number.

• formatNumeric

  public java.lang.String formatNumeric(java.lang.Integer amount)
  

  Formats the Integer numeric value in a locale-independent manner.

  Parameters:

  amount - The Integer value.

  Returns:

  The formatted number.

• mapException

  public ECException mapException(ECException exception)
  

  Map the exception to one that is appropriate for the IBM Sales Center client. If an exception occurs while processing a client request, then this method is invoked. This method will allow the response builder to override the message that is sent back to the client.

  Sub classes need to override. The default implementation just returns the exception unchanged.

  Specified by:

  mapException in interface ITelesalesResponseBuilder

  Parameters:

  exception - the original exception

  Returns:

  The new exception.

  See Also:

  ITelesalesResponseBuilder.mapException(com.ibm.commerce.exception.ECException)

• getRetrieveDetailsFlag

  protected boolean getRetrieveDetailsFlag(SearchCriteria aSearchCriteria)
  

  This obtains the value corresponding to the GetDetails select expression in the search criteria. If the GetDetails select expression does not exist in the search criteria, this method will return true.

  Parameters:

  aSearchCriteria - the search criteria which contains the select expression.

  Returns:

  False ,if the value corresponding to the GetDetails select expression is false. True, otherwise.

• serializeXML

  protected java.lang.String serializeXML(org.w3c.dom.Document document)
                                   throws javax.xml.transform.TransformerException,
                                          java.io.IOException,
                                          ECSystemException
  

  Serializes the XML document into a String.

  Parameters:

  document - The XML document.

  Returns:

  A string representation of the XML document.

  Throws:

  javax.xml.transform.TransformerException - Problem transforming the XML document into a String.

  java.io.IOException

  ECSystemException

• getCacheableCommand

  public ITelesalesResponseCacheableCommand getCacheableCommand()
                                                         throws ECException
  

  Create a cacheable command that will return the cacheable response. Subclasses may override. This implementation will always return null.

  Specified by:

  getCacheableCommand in interface ITelesalesResponseBuilder

  Returns:

  cacheable command. This implementation returns null.

  Throws:

  ECException

  See Also:

  ITelesalesResponseBuilder.getCacheableCommand()