public class CancelSalesOrderRequest extends SalesOrderRequest
Modifier and Type | Field and Description |
---|---|
protected org.w3c.dom.Element | customerPartyElement_
customerPartyElement_ contains the request document's CustomerParty element.
|
protected org.w3c.dom.Element | documentIdsElement_
documentIdsElement_ contains the request document's DocumentIds element.
|
protected org.w3c.dom.Element | headerElement_
headerElement_ contains the request document's Header element.
|
protected org.w3c.dom.Element | orderCommentElement_
orderCommentElement_ contains the request document's OrderComment element.
|
protected org.w3c.dom.Element | partiesElement_
partiesElement_ contains the request document's Parties element.
|
protected org.w3c.dom.Element | partyIdElement_
partyIdElement_ contains the request document's PartyId element.
|
protected org.w3c.dom.Element | salesOrderElement_
salesOrderElement_ contains the request document's Order element.
|
Constructor and Description |
---|
CancelSalesOrderRequest()
Default constructor to create a new request.
|
Modifier and Type | Method and Description |
---|---|
protected org.w3c.dom.Element | createCustomerPartyElement()
This method builds the CustomerParty element and adds it as a child of partiesElement_.
|
protected org.w3c.dom.Element | createDataAreaElement()
This method builds the DataArea element and adds it as a child of rootElement_.
|
protected org.w3c.dom.Element | createDocumentIdElement()
This method builds the DocumentId element and adds it as a child of documentIdsElement_.
|
protected org.w3c.dom.Element | createDocumentIdsElement()
This method builds the DocumentIds element and adds it as a child of headerElement_.
|
protected org.w3c.dom.Element | createHeaderElement()
This method builds the Header element and adds it as a child of salesOrderElement_.
|
protected org.w3c.dom.Element | createOrderCommentElement()
This method builds the OrderComment element and adds it as a child of headerElement_.
|
protected org.w3c.dom.Element | createPartiesElement()
This method builds the Parties element and adds it as a child of headerElement_.
|
protected org.w3c.dom.Element | createPartyIdElement()
This method builds the PartyId element and adds it as a child of customerPartyElement_.
|
protected org.w3c.dom.Element | createSalesOrderElement()
This method builds the SalesOrder element and adds it as a child of dataAreaElement_.
|
protected org.w3c.dom.Element | createSenderElement()
This method builds the Sender element and adds it as a child of applicationAreaElement_.
|
protected org.w3c.dom.Document | getRequestBod()
This method constructs the request document.
|
protected java.lang.String[] | getRequestNodePathsToMask()
The CancelSalesOrderRequest implementation returns the following array of request node paths SyncSalesOrder/DataArea/SalesOrder/Header/Parties/BillToParty/PaymentInstructions/UserDataField which needs to be masked because of sensitive information.
|
protected Session | getResponseData()
This method returns the unmarshalled response com.ibm.commerce.telesales.model.Order data bean.
|
protected java.lang.String[] | getResponseNodePathsToMask()
The CancelSalesOrderRequest implementation returns following array of response node paths ConfirmSalesOrder/DataArea/BOD/NounOutcome/SalesOrder/Header/Parties/BillToParty/PaymentInstruction/UserDataField and ConfirmSalesOrder/DataArea/BOD/NounOutcome/SalesOrder/Header/PaymentTerms/AvailablePaymentMethods/PaymentMethods/PaymentAttributes/PaymentAttribute which needs to be masked because of sensitive information.
|
ServiceContext | getServiceContext()
This method returns ServiceContext object specific to this request.
|
protected java.lang.String | getXSDFileName()
This method returns the name of the schema file for the request BOD (Business Object Document).
|
protected org.w3c.dom.Element customerPartyElement_
protected org.w3c.dom.Element documentIdsElement_
protected org.w3c.dom.Element headerElement_
protected org.w3c.dom.Element orderCommentElement_
protected org.w3c.dom.Element partiesElement_
protected org.w3c.dom.Element partyIdElement_
protected org.w3c.dom.Element salesOrderElement_
public CancelSalesOrderRequest()
protected Session getResponseData()
public ServiceContext getServiceContext()
protected java.lang.String getXSDFileName()
protected org.w3c.dom.Document getRequestBod()
<CancelSalesOrder> <!-- created by the createWCRootElement method --> . . </CancelSalesOrder>
protected org.w3c.dom.Element createCustomerPartyElement()
The following outline shows the structure of the CustomerParty element and its construction:
<oa:CustomerParty> <oa:PartyId> <!-- constructed by createPartyIdElement() --> . . </oa:PartyId> </oa:CustomerParty>
protected org.w3c.dom.Element createDataAreaElement()
The following outline shows the structure of the DataArea element and its construction:
<DataArea> <oa:Cancel confirm="Never"/> <SalesOrder> <!-- constructed by createSalesOrderElement() --> . . </SalesOrder> </DataArea>
protected org.w3c.dom.Element createDocumentIdElement()
The following outline shows the structure of the DocumentId element and its construction:
<oa:DocumentId> <oa:Id>100</oa:Id> <!-- order.getContainerId() --> </oa:DocumentId>
protected org.w3c.dom.Element createDocumentIdsElement()
The following outline shows the structure of the DocumentIds element and its construction:
<oa:DocumentIds> <oa:DocumentId> <!-- createDocumentIdElement() --> . . </oa:DocumentId> </oa:DocumentIds>
protected org.w3c.dom.Element createHeaderElement()
The following outline shows the structure of the Header element and its construction:
<Header> <DocumentIds> <!-- constructed by createDocumentIdsElement() --> . . </DocumentIds> <Description lang="en-US" owner="">String</Description> <Note author="String" lang="en-US">String</Note> <PerformPaymentRefund/> <!-- order.getPerformPaymentRefund() --> <OrderComment> <!-- constructed by createOrderCommentElement() --> . . </OrderComment> <Parties> <!-- constructed by createPartiesElement() --> . . </Parties> <UserArea/> <ForUserId>52</ForUserId> <!-- memberId of the "customer" TelesalesProperties property --> <CommerceArea> <!-- constructed by createCommerceAreaElement() --> . . </CommerceArea> </Header>
protected org.w3c.dom.Element createPartiesElement()
The following outline shows the structure of the Parties element and its construction:
<oa:Parties> <oa:CustomerParty> <!-- constructed by createCustomerPartiesElement() --> . . </oa:CustomerParty> </oa:Parties>
protected org.w3c.dom.Element createOrderCommentElement()
The following outline shows the structure of the OrderComment element and its construction:
<OrderComment> <Description>description</Description> <!-- order.getOrderComment() --> <NotifyCustomer>0</NotifyCustomer> <!-- order.getNotifyCustomer() --> <CustomersEmailAddress>user@company.com</CustomersEmailAddress> <!-- order.getCustomersEmailAddress() --> </OrderComment>
protected org.w3c.dom.Element createPartyIdElement()
The following outline shows the structure of the PartyId element and its construction:
<oa:PartyId> <oa:Id/> <!-- customer.getMemberId() --> </oa:PartyId>
protected org.w3c.dom.Element createSalesOrderElement()
The following outline shows the structure of the SalesOrder element and its construction:
<SalesOrder> <Header> <!-- constructed by createHeaderElement() --> . . </Header> <UserData> <!-- constructed by createUserDataElement("order") --> . . </UserData> </SalesOrder>
protected org.w3c.dom.Element createSenderElement()
The following sample Sender element shows how the element is constructed:
<oa:Sender> <oa:LogicalId>TSCLIENT</oa:LogicalId> <oa:Component>SalesOrder</oa:Component> <oa:Task>CancelSalesOrder</oa:Task> <oa:ReferenceId>-1680589954192190044</oa:ReferenceId> <!-- value of getServiceRequestContext --> <oa:Confirmation>2</oa:Confirmation> <oa:AuthorizationId>LOGON_TOKEN_ID_SCAFFOLDING</oa:AuthorizationId> <!-- value of ContextManager.getInstance().getSessionCtx() --> </oa:Sender>
protected java.lang.String[] getRequestNodePathsToMask()
protected java.lang.String[] getResponseNodePathsToMask()