public abstract class TelesalesResponseBuilderImpl extends java.lang.Object implements ITelesalesResponseBuilder
This class provides common methods that facilitate the construction of response Business Object Documents (BODs).
Modifier and Type | Field and Description |
---|---|
static java.lang.String | CLASSNAME
Define the CLASSNAME.
|
static java.lang.String | COPYRIGHT
IBM Copyright notice field
|
static java.lang.String | DEFAULT_DOCUMENT_FIELD_VALUE
The default value for document element field.
|
java.lang.String | DEFAULT_SEARCH_TYPE_VALUE
The default value for the search type value.
|
protected org.w3c.dom.Element | iApplicationAreaElement
The iApplicationAreaElement contains the response document's ApplicationArea element.
|
protected org.w3c.dom.Element | iBodElement
The iBodElement contains the response document's BOD element.
|
protected org.w3c.dom.Element | iBodHeaderElement
The iBodHeaderElement contains the response document's BODHeader element.
|
protected org.w3c.dom.Element | iCommerceAreaElement
The iCommerceAreaElement contains the response document's CommerceArea element.
|
protected org.w3c.dom.Element | iDataAreaElement
The iDataAreaElement contains the response document's DataArea element.
|
protected org.w3c.dom.Element | iNounOutcomeElement
The iNounOutcomeElement contains the response document's NounOutcome element.
|
protected org.w3c.dom.Element | iOriginalApplicationAreaElement
The iOriginalApplicationAreaElement contains the response document's originalApplicationArea element.
|
protected org.w3c.dom.Element | iRootElement
The iRootElement contains the response document's root element.
|
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.
|
Constructor and Description |
---|
TelesalesResponseBuilderImpl() |
Modifier and Type | Method and Description |
---|---|
protected void | buildApplicationArea()
Creates the root document element and Builds the ApplicationArea section of the document.
|
protected void | buildConfirmDataArea()
Builds the Confirm BOD DataArea.
|
protected abstract void | buildDataArea()
Builds the DataArea of the response document.
|
protected void | buildFailureElement()
Builds the BOD elements when an error or exception occurred.
|
java.lang.String | buildResponse()
Constructs the response Business Object Document.
|
protected void | buildResultArea()
Builds the Result specific section of the Business Object Document.
|
protected void | buildSuccessElement()
Builds the BODSuccess and NounOutcome element payload of the Business Object Document.
|
protected org.w3c.dom.Element | createApplicationAreaElement()
Builds the ApplicationArea element.
|
protected org.w3c.dom.Element | createBodFailureElement(org.w3c.dom.Element aParentElement, java.lang.String astrReasonCode, java.lang.String astrDescription)
Builds the BODFailure element under the BODHeader element.
|
protected org.w3c.dom.Element | createBodSuccessElement(org.w3c.dom.Element aParentElement)
Creates the BODSuccess element.
|
protected org.w3c.dom.Element | createCommerceAreaElement(org.w3c.dom.Element aParentElement)
Builds the CommerceArea element.
|
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.
|
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.
|
protected org.w3c.dom.Element | createDocumentIdsElement(org.w3c.dom.Element aParentElement, java.lang.String astrDocumentId)
Creates the DocumentIds element for the given parent element and document Id.
|
protected org.w3c.dom.Element | createNounFailureElement(org.w3c.dom.Element aParentElement, java.lang.String astrReasonCode, java.lang.String astrDescription)
Builds the NounFailure element under the NounOutcome element for an error or failure.
|
protected org.w3c.dom.Element | createNounOutcomeElement(org.w3c.dom.Element aParentElement)
Creates the NounOutcome element.
|
protected org.w3c.dom.Element | createNounOutcomeElement(org.w3c.dom.Element aParentElement, java.lang.String astrDocumentId)
Creates the NounOutcome element for the given parent element and document Id.
|
protected org.w3c.dom.Element | createNounOutcomeFailureElement(org.w3c.dom.Element aParentElement, java.lang.String astrReasonCode, java.lang.String astrDescription)
Builds the NounOutcome element under the BOD element for an error or failure.
|
protected org.w3c.dom.Element | createNounSuccessElement(org.w3c.dom.Element aParentElement)
Creates the NounSuccess element for the given parent element.
|
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.
|
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.
|
protected org.w3c.dom.Element | createOriginalApplicationAreaElement(org.w3c.dom.Element aParentElement)
Builds the OriginalApplicationArea element.
|
protected org.w3c.dom.Element | createPartyIdElement(java.lang.String aStrValue, org.w3c.dom.Element aParentElement)
Builds the PartyId element.
|
protected org.w3c.dom.Element | createRootDocumentElement(java.lang.String astrRootElementName)
Creates the root element.
|
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)
Builds the Sender element for the parent element provided.
|
protected org.w3c.dom.Element | createSenderElementForApplicationArea()
Builds the Sender element for the ApplicationArea element.
|
protected org.w3c.dom.Element | createUserAreaElement(org.w3c.dom.Element aParentElement)
Creates the UserArea element for the given parent element.
|
protected org.w3c.dom.Element | createUserDataElement(SearchResultBean aSearchResultBean, org.w3c.dom.Element aParentElement)
Creates the UserData element.
|
protected org.w3c.dom.Element | createUserDataFieldElement(org.w3c.dom.Element aParentElement, java.lang.String astrName, java.lang.String astrValue)
Builds the UserDataField element.
|
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.
|
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.
|
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.
|
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.
|
protected java.lang.String | determineMessageId()
Determine the message id when error occurred.
|
protected java.lang.String | determineRequestAuthorizationID()
Determine the authorization Id in the Sender element under ApplicationArea of the request BOD
|
protected java.lang.String | determineRequestComponent()
Determine the component in the Sender element under ApplicationArea of the request BOD
|
protected java.lang.String | determineRequestLogonID()
Determine the logon ID of the request.
|
protected java.lang.String | determineRequestMachineName()
Determine the machine name in the BODId element under ApplicationArea of the request BOD.
|
protected java.lang.String | determineRequestReferenceID()
Determine the reference Id in the Sender element under ApplicationArea of the request BOD
|
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.
|
java.lang.String | formatNumeric(java.lang.Double amount)
Formats the Double numeric value in a locale-independent manner.
|
java.lang.String | formatNumeric(java.lang.Integer amount)
Formats the Integer numeric value in a locale-independent manner.
|
ITelesalesResponseCacheableCommand | getCacheableCommand()
Create a cacheable command that will return the cacheable response.
|
protected CommandContext | getCmdCtxt()
Gets the command context.
|
protected java.lang.String | getDateTime(java.lang.String astrFormat)
Gets the current date or time in the requested format.
|
protected java.lang.String | getDefaultSearchTypeValue(java.lang.String astrSearchType)
Returns the search type value for the given search type.
|
protected org.w3c.dom.Element | getDocumentRoot()
Gets the root of the response Business Object Document.
|
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.
|
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.
|
protected com.ibm.icu.text.NumberFormat | getNumberFormat()
Returns the NumberFormat to be used to format a number.
|
protected org.w3c.dom.Document | getRequestBod()
Gets the request Business Object Document.
|
protected TypedProperty | getRequestProperties()
Gets the request properties.
|
protected org.w3c.dom.Document | getResponseBod()
Gets the response Business Object Document.
|
protected java.lang.String | getResponseBusinessObjectDocumentWithCDATA(java.lang.String responseObject)
This method is used to wrap the XML response with CDATA element.
|
protected TypedProperty | getResponseProperties()
Gets the response properties.
|
protected boolean | getRetrieveDetailsFlag(SearchCriteria aSearchCriteria)
This obtains the value corresponding to the GetDetails select expression in the search criteria.
|
protected abstract java.lang.String | getRootElementName()
Gets the root element name of the response document.
|
protected SearchCriteria | getSearchCriteria(org.w3c.dom.Document aRequestBod)
Gets the search criteria from the request Business Object Document.
|
protected java.lang.String | getSearchTypeValue(java.lang.String astrSearchType)
Returns the search type value for the given search type.
|
protected java.lang.String | getTagNameWithoutNameSpace(java.lang.String astrName)
Gets the local name of the given tag name.
|
protected java.lang.String | getTaskName()
Gets the task name from the request Business Object Document.
|
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.
|
void | initializeDefaultSearchTypeMapping(java.util.Map searchTypeMappings)
Initialize the specified map with the default search values and search types.
|
protected void | initializeSearchTypeMapping()
Initialize the mapping between the search type values and the search types.
|
protected boolean | isResponseWrapWithCDATAElement()
This method is used to confirm whether response should be wrapped using CDATA or not.
|
ECException | mapException(ECException exception)
Map the exception to one that is appropriate for the IBM Sales Center client.
|
static void | printDOM(org.w3c.dom.Node aNode, java.io.FileWriter aFileWriter)
Prints the given node and its children for debugging purpose.
|
protected static java.lang.String | returnEmptyStringIfNull(java.lang.String inputString)
Returns an empty string if the input string is null.
|
protected java.lang.String | serializeXML(org.w3c.dom.Document document)
Serializes the XML document into a String.
|
protected org.w3c.dom.Element | setGeneralAttributesForRootDocumentElement(org.w3c.dom.Element aRootElement)
Sets the general attributes for the given root document element.
|
protected org.w3c.dom.Element | setNameSpaceAttributesForRootDocumentElement(org.w3c.dom.Element aRootElement)
Sets the name space attributes for the given root document element.
|
protected void | setRequestBod(org.w3c.dom.Document reqBodToSet)
Sets the request Business Object Document.
|
protected org.w3c.dom.Element | setSchemaInstanceAttributeForRootDocumentElement(org.w3c.dom.Element aRootElement)
Sets the schema instance attributes for the given root document element.
|
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.
|
protected void | unmarshallCommerceArea(org.w3c.dom.Node node)
Unmarshall the CommerceArea element of the given document node.
|
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.
|
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.
|
protected void | unmarshallNoun(org.w3c.dom.Node node)
Unmarshall the Noun element of the given document node.
|
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.
|
protected java.lang.String | unmarshallTextNode(org.w3c.dom.Node textNode)
Unmarshall a given text node.
|
public static final java.lang.String CLASSNAME
public static final java.lang.String COPYRIGHT
public static final java.lang.String DEFAULT_DOCUMENT_FIELD_VALUE
protected org.w3c.dom.Element iRootElement
protected org.w3c.dom.Element iApplicationAreaElement
protected org.w3c.dom.Element iCommerceAreaElement
protected org.w3c.dom.Element iOriginalApplicationAreaElement
protected org.w3c.dom.Element iDataAreaElement
protected org.w3c.dom.Element iBodElement
protected org.w3c.dom.Element iBodHeaderElement
protected org.w3c.dom.Element iNounOutcomeElement
protected java.util.HashMap iSearchTypeMappings
public java.lang.String DEFAULT_SEARCH_TYPE_VALUE
public void init(CommandContext aCmdCtxt, TypedProperty aRequestProperties, TypedProperty aResponseProperties, org.w3c.dom.Document aRequestBOD, org.w3c.dom.Document aResponseBOD)
This method also retrieve the task name from the request Business Object Document and sets the task name.
protected org.w3c.dom.Element createWCDocumentElement(org.w3c.dom.Element aParentElement, java.lang.String astrElementName, java.lang.String astrValue)
protected org.w3c.dom.Element createWCDocumentElement(org.w3c.dom.Element aParentElement, java.lang.String astrElementName)
protected org.w3c.dom.Element createOADocumentElement(org.w3c.dom.Element aParentElement, java.lang.String astrElementName, java.lang.String astrValue)
protected org.w3c.dom.Element createOADocumentElement(org.w3c.dom.Element aParentElement, java.lang.String astrElementName)
protected org.w3c.dom.Element createDocumentElementNS(java.lang.String astrNameSpace, org.w3c.dom.Element aParentElement, java.lang.String astrElementName, java.lang.String astrValue)
protected org.w3c.dom.Element createDocumentElementNS(java.lang.String astrNameSpace, org.w3c.dom.Element aParentElement, java.lang.String astrElementName)
Usage example: createDocumentElementNS(BodConstants.XML_WC_NAMESPACE, parentElement, "wc:newElementName")
protected com.ibm.icu.text.NumberFormat getNumberFormat()
protected org.w3c.dom.Element createWCDocumentElement(org.w3c.dom.Element parentElement, java.lang.String elementName, java.math.BigDecimal value)
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.
protected org.w3c.dom.Element createWCDocumentElement(org.w3c.dom.Element parentElement, java.lang.String elementName, java.lang.Long value)
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.
protected org.w3c.dom.Element createRootDocumentElement(java.lang.String astrRootElementName)
This method calls the following methods to create the attribute of the root element.
protected org.w3c.dom.Element setNameSpaceAttributesForRootDocumentElement(org.w3c.dom.Element aRootElement)
Here is what is being set:
xmlns:wc="http://www.ibm.com/WebsphereCommerce/Telesales/oagis" xmlns:oa="http://www.openapplications.org/oagis"
protected org.w3c.dom.Element setSchemaLocationAttributeForRootDocumentElement(org.w3c.dom.Element aRootElement, java.lang.String astrRootElementName)
Here is what is being set:
xsi:schemaLocation="http://www.ibm.com/WebsphereCommerce/Telesales/oagis ../BODs/ConfirmSalesOrder.xsd">
protected org.w3c.dom.Element setSchemaInstanceAttributeForRootDocumentElement(org.w3c.dom.Element aRootElement)
Here is what is being set:
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
protected org.w3c.dom.Element setGeneralAttributesForRootDocumentElement(org.w3c.dom.Element aRootElement)
Here is what is being set:
environment="Test" lang="en-US" revision="8.1" version="8.1"
protected org.w3c.dom.Element createBodFailureElement(org.w3c.dom.Element aParentElement, java.lang.String astrReasonCode, java.lang.String astrDescription) throws ECException
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>
protected org.w3c.dom.Element createNounOutcomeFailureElement(org.w3c.dom.Element aParentElement, java.lang.String astrReasonCode, java.lang.String astrDescription) throws ECException
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>
protected org.w3c.dom.Element createNounFailureElement(org.w3c.dom.Element aParentElement, java.lang.String astrReasonCode, java.lang.String astrDescription) throws ECException
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>
protected org.w3c.dom.Element createApplicationAreaElement() throws ECException
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>
protected org.w3c.dom.Element createCommerceAreaElement(org.w3c.dom.Element aParentElement) throws ECException
The following sample indicates the structure of the CommerceArea element and how it is constructed.
<CommerceArea> <StoreId>0</StoreId> <LanguageId>0</LanguageId> </CommerceArea>
protected org.w3c.dom.Element createOriginalApplicationAreaElement(org.w3c.dom.Element aParentElement) throws ECException
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.
protected org.w3c.dom.Element createSenderElementForApplicationArea() throws ECException
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>
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
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>
protected org.w3c.dom.Element createBodSuccessElement(org.w3c.dom.Element aParentElement) throws ECException
protected org.w3c.dom.Element createDocumentIdsElement(org.w3c.dom.Element aParentElement, java.lang.String astrDocumentId) throws ECException
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>
protected org.w3c.dom.Element createNounOutcomeElement(org.w3c.dom.Element aParentElement, java.lang.String astrDocumentId) throws ECException
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>
protected org.w3c.dom.Element createNounSuccessElement(org.w3c.dom.Element aParentElement) throws ECException
protected org.w3c.dom.Element createUserAreaElement(org.w3c.dom.Element aParentElement) throws ECException
protected org.w3c.dom.Element createNounOutcomeElement(org.w3c.dom.Element aParentElement) throws ECException
protected org.w3c.dom.Element createPartyIdElement(java.lang.String aStrValue, org.w3c.dom.Element aParentElement)
protected void buildSuccessElement() throws ECException
protected org.w3c.dom.Element createUserDataFieldElement(org.w3c.dom.Element aParentElement, java.lang.String astrName, java.lang.String astrValue) throws ECException
protected org.w3c.dom.Element createUserDataElement(SearchResultBean aSearchResultBean, org.w3c.dom.Element aParentElement) throws ECException
protected void buildResultArea() throws ECException
protected void buildConfirmDataArea() throws ECException
This calls the method createOriginalApplicationAreaElement to build the OriginalApplicationArea section of the DataArea.
protected void buildFailureElement() throws ECException
protected static java.lang.String returnEmptyStringIfNull(java.lang.String inputString)
protected TypedProperty getRequestProperties()
protected TypedProperty getResponseProperties()
protected org.w3c.dom.Document getRequestBod()
protected CommandContext getCmdCtxt()
protected org.w3c.dom.Element getDocumentRoot()
protected void setRequestBod(org.w3c.dom.Document reqBodToSet)
protected org.w3c.dom.Document getResponseBod()
protected java.lang.String getTaskName()
public java.lang.String buildResponse() throws ECException
protected java.lang.String getResponseBusinessObjectDocumentWithCDATA(java.lang.String responseObject)
protected boolean isResponseWrapWithCDATAElement()
public static void printDOM(org.w3c.dom.Node aNode, java.io.FileWriter aFileWriter)
protected void buildApplicationArea() throws ECException
protected abstract void buildDataArea() throws ECException
protected abstract java.lang.String getRootElementName()
protected SearchCriteria getSearchCriteria(org.w3c.dom.Document aRequestBod)
protected void unmarshallDataArea(SearchCriteria aSearchCriteria, org.w3c.dom.Node aNode, java.lang.String astrNoun)
protected void unmarshallGet(SearchCriteria searchCriteria, org.w3c.dom.Node node)
protected void unmarshallNoun(org.w3c.dom.Node node)
protected void unmarshallCommerceArea(org.w3c.dom.Node node)
protected void unmarshallReturnCriteria(SearchCriteria aSearchCriteria, org.w3c.dom.Node node)
protected java.lang.String unmarshallTextNode(org.w3c.dom.Node textNode)
protected void initializeSearchTypeMapping()
public void initializeDefaultSearchTypeMapping(java.util.Map searchTypeMappings)
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
protected java.lang.String getDefaultSearchTypeValue(java.lang.String astrSearchType)
protected java.lang.String getSearchTypeValue(java.lang.String astrSearchType)
protected java.lang.String getTagNameWithoutNameSpace(java.lang.String astrName)
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.
protected org.w3c.dom.Node findNodeWithLocalName(org.w3c.dom.Node aNode, java.lang.String astrName)
protected java.lang.String getElementValueByLocalName(org.w3c.dom.Node aNode, java.lang.String astrParentTagName, java.lang.String astrName)
protected java.lang.String getElementAttributeValueByLocalName(org.w3c.dom.Node aNode, java.lang.String astrTagname, java.lang.String astrAttributeName)
protected java.lang.String determineRequestReferenceID()
protected java.lang.String determineRequestAuthorizationID()
protected java.lang.String determineRequestLogonID()
protected java.lang.String determineRequestMachineName()
protected java.lang.String getDateTime(java.lang.String astrFormat)
protected java.lang.String determineRequestComponent()
protected java.lang.String determineMessageId()
public java.lang.String formatNumeric(java.lang.Double amount)
public java.lang.String formatNumeric(java.lang.Integer amount)
public ECException mapException(ECException exception)
Sub classes need to override. The default implementation just returns the exception unchanged.
protected boolean getRetrieveDetailsFlag(SearchCriteria aSearchCriteria)
protected java.lang.String serializeXML(org.w3c.dom.Document document) throws javax.xml.transform.TransformerException, java.io.IOException, ECSystemException
public ITelesalesResponseCacheableCommand getCacheableCommand() throws ECException