Field Detail

• logonElement_

  protected org.w3c.dom.Element logonElement_
  

  logonElement_ contains the request document's Logon element. It is initialized by the createLogonElement method.

  See Also:

  createLogonElement()

• userAccountElement_

  protected org.w3c.dom.Element userAccountElement_
  

  userAccountElement_ contains the request document's UserAccount element. It is initialized by the createUserAccountElement method.

  See Also:

  createUserAccountElement()

• authorizationElement_

  protected org.w3c.dom.Element authorizationElement_
  

  authorizationElement_ contains the request document's Authorization element. It is initialized by the createAuthorizationElement method.

  See Also:

  createAuthorizationElement()

Constructor Detail

• ProcessLogonRequest

  public ProcessLogonRequest()
  

  Creates a new request handler.

Method Detail

• getResponseData

  protected Session getResponseData()
  

  Returns the unmarshalled response data in the form of a com.ibm.commerce.telesales.model.Operator object. This is the "operator" TelesalesProperties property.

  Specified by:

  getResponseData in class TelesalesRequest

  Returns:

  Session object containing the response object

  See Also:

  TelesalesRequest.getResponseData()

• getServiceContext

  public ServiceContext getServiceContext()
  

  Constructs the service context for this service request.

  Returns:

  The service context.

  See Also:

  ITelesalesRequestHandler.getServiceContext()

• getXSDFileName

  protected java.lang.String getXSDFileName()
  

  Returns the name of the schema file for the request BOD (Business Object Document). The value is "../BODs/ProcessLogon.xsd".

  Specified by:

  getXSDFileName in class TelesalesRequest

  Returns:

  schema file name.

  See Also:

  TelesalesRequest.getXSDFileName()

• getRequestBod

  protected org.w3c.dom.Document getRequestBod()
  

  Constructs the request document. The following outline shows the structure of the request document and its construction.

  
    <ProcessLogon> <!-- created by the createWCRootElement method -->
       .
       .
    </ProcessLogon>
  
   
  

  Specified by:

  getRequestBod in class TelesalesRequest

  Returns:

  Document object containing the request Business Object Document.

  See Also:

  TelesalesRequest.getRequestBod(), TelesalesRequest.createWCRootElement(String), TelesalesRequest.document_

• createDataAreaElement

  protected org.w3c.dom.Element createDataAreaElement()
  

  Builds the DataArea element and adds it as a child of rootElement_. The element is stored in dataAreaElement_.

  The following outline shows the structure of the DataArea element and its construction:

  
    <DataArea>
       <Process acknowledge="Always" confirm="Always"/>
       <Logon> <!-- constructed by createLogonElement() -->
          .
          .
       </Logon>
    </DataArea>
  
   
  

  Overrides:

  createDataAreaElement in class TelesalesRequest

  Returns:

  The DataArea element.

  See Also:

  TelesalesRequest.createDataAreaElement(), TelesalesRequest.dataAreaElement_, createLogonElement()

• createLogonElement

  protected org.w3c.dom.Element createLogonElement()
  

  Builds the Logon element and adds it as a child of dataAreaElement_. The element is stored in logonElement_. If you pass in an Operator object under the "operator" TelesalesProperties property, then any user data properties will be included in the UserData element.

  The following outline shows the structure of the Logon element and its construction:

    <Logon>
       <UserAccount> <!-- constructed by createUserAccountElement() -->
          .
          .
       </UserAccount>
       <CommerceArea> <!-- constructed by createCommerceAreaElement() -->
  
       </CommerceArea>
       <wc:UserData> <!-- constructed by createUserDataElement() -->
                          <wc:UserDataField name="name">value</wc:UserDataField>
                          .
                  </wc:UserData>
    </Logon>
   
  

  Returns:

  The Logon element.

  See Also:

  logonElement_, createUserAccountElement(), TelesalesRequest.createCommerceAreaElement(Element), TelesalesRequest.createUserDataElement(Element, ModelObject)

• createSenderElement

  protected org.w3c.dom.Element createSenderElement()
  

  Builds the Sender element and adds it as a child of applicationAreaElement_. The element is stored in senderElement_.

  The following sample Sender element shows how the element is constructed:

    <oa:Sender>
       <oa:LogicalId>TSCLIENT</oa:LogicalId>
       <oa:Component>Logon</oa:Component>
       <oa:Task>LogonOperator</oa:Task>
       <oa:ReferenceId>-1680589954192190044</oa:ReferenceId> <!-- value of getActionCtx -->
       <oa:Confirmation>2</oa:Confirmation>
       <oa:AuthorizationId/>
    </oa:Sender>
   
  

  Overrides:

  createSenderElement in class TelesalesRequest

  Returns:

  The Sender element.

  See Also:

  TelesalesRequest.createSenderElement(), TelesalesRequest.senderElement_

• createUserAccountElement

  protected org.w3c.dom.Element createUserAccountElement()
  

  Builds the UserAccount element and adds it as a child of logonElement_. The element is stored in userAccountElement_.

  The following sample UserAccount element shows how the element is constructed:

    <UserAccount>
       <Authorization> <!-- constructed by createAuthorizationElement -->
          .
          .
       </Authorization>
    </UserAccount>
   
  

  Returns:

  The UserAccount element.

  See Also:

  userAccountElement_, logonElement_, createAuthorizationElement()

• createAuthorizationElement

  protected org.w3c.dom.Element createAuthorizationElement()
  

  Builds the Authorization element and adds it as a child of userAccountElement_. The element is stored in authorizationElement_.

  The following sample Authorization element shows how the element is constructed:

    <Authorization>
       <Password>wcsadmin</Password> <!-- "password" or "new.password" TelesalesProperties property -->
       <UserId>wcsadmin</UserId>     <!-- "username" TelesalesProperties property -->
    </Authorization>
   
  

  Returns:

  The UserAccount element.

  See Also:

  authorizationElement_, userAccountElement_

• unmarshallResponseBod

  protected void unmarshallResponseBod(org.w3c.dom.Document bod)
  

  Unmarshalls the response BOD. This method calls unmarshallAcknowledgeLogon() to unmarshall the root element. A new Operator object is constructed and stored in the "operator" TelesalesProperties property.

  Specified by:

  unmarshallResponseBod in class TelesalesRequest

  Parameters:

  bod - Document object containing the response BOD. This will be unmarshalled.

  See Also:

  TelesalesRequest.unmarshallResponseBod(org.w3c.dom.Document), unmarshallAcknowledgeLogon(Operator, Element)

• unmarshallAcknowledge

  protected void unmarshallAcknowledge(Operator operator,
                           org.w3c.dom.Element acknowledgeElement)
  

  Unmarshalls the Acknowledge element. The following sample shows the structure of the Acknowledge element and how it is unmarshalled.

    <Acknowledge>
       <oa:Code>Accepted</oa:Code> <!-- operator.setAcknowledgeCode() -->
    </Acknowledge>
   
  

  Parameters:

  operator - The data bean to populate.

  acknowledgeElement - The element to unmarshall.

• unmarshallAcknowledgeLogon

  protected void unmarshallAcknowledgeLogon(Operator operator,
                                org.w3c.dom.Element acknowledgeLogonElement)
  

  Unmarshalls the AcknowledgeLogon element. The following sample shows the structure of the AcknowledgeLogon element and how it is unmarshalled.

    <AcknowledgeLogon>
       <oa:ApplicationArea> <!-- unmarshalled by unmarshallApplicationArea() -->
         .
         .
       </oa:ApplicationArea>
       <DataArea> <!-- unmarshalled by unmarshallDataArea() -->
         .
         .
       </DataArea>
    </AcknowledgeLogon>
   
  

  Parameters:

  operator - The data bean that is populated.

  acknowledgeLogonElement - The element that is unmarshalled.

• unmarshallAuthorization

  protected void unmarshallAuthorization(Operator operator,
                             org.w3c.dom.Element authorizationElement)
  

  Unmarshalls the Authorization element. The following sample shows the structure of the Authorization element and how it is unmarshalled. This method also stores the "password" TelesalesProperties property in operator.

    <Authorization>
       <UserId>wcsadmin</UserId> <!-- operator.setUID() -->
    </Authorization>
   
  

  Parameters:

  operator - The data bean that is populated.

  authorizationElement - The element that is unmarshalled.

• unmarshallCommerceArea

  protected void unmarshallCommerceArea(Operator operator,
                            org.w3c.dom.Element commerceAreaElement)
  

  Unmarshalls the CommerceArea element. The following sample shows the structure of the CommerceArea element and how it is unmarshalled.

    <CommerceArea>
       <StoreId>1000</StoreId>        <!-- stored in "store.id" TelesalesProperties property -->
       <LanguageId>en-US</LanguageId> <!-- operator.setLanguageId() -->
       <BusinessChannels> <!-- unmarshalled by unmarshallBusinessChannels() -->
          .
          .
       </BusinessChannels>
       <Languages> <!-- unmarshalled by unmarshallLanguages() -->
          .
          .
       </Languages>
    </CommerceArea>
   
  

  Parameters:

  operator - The data bean that is populated.

  commerceAreaElement - The element that is unmarshalled.

  See Also:

  unmarshallBusinessChannels(Element), unmarshallLanguages(Element)

• unmarshallLanguages

  protected void unmarshallLanguages(org.w3c.dom.Element languagesElement)
  

  Unmarshalls the Languages element. The following sample shows the structure of the Languages element and how it is unmarshalled.

    <Languages>
       <Language>
         <LanguageId>-1</LanguageId>
         <LanguageDescription>United States English</LanguageDescription>
       </Language>
          .
          .
       <Language>
          .
          .
       </Language>
    </Languages>
   
  

  Parameters:

  languagesElement - The element that is unmarshalled.

  See Also:

  ModelRoot.addLanguage(String, String)

• unmarshallDataArea

  protected void unmarshallDataArea(Operator operator,
                        org.w3c.dom.Element dataAreaElement)
  

  Unmarshalls the DataArea element. The following sample shows the structure of the DataArea element and how it is unmarshalled.

  
    <DataArea>
       <Acknowledge> <!-- unmarshalled by unmarshallAcknowledge() -->
         .
         .
       </Acknowledge>
       <Logon> <!-- unmarshalled by unmarshallLogon() -->
         .
         .
       </Logon>
    </DataArea>
  
   
  

  Parameters:

  operator - The data bean to populate.

  dataAreaElement - The element that is unmarshalled.

  See Also:

  unmarshallAcknowledge(Operator, Element), unmarshallLogon(Operator, Element)

• unmarshallLogon

  protected void unmarshallLogon(Operator operator,
                     org.w3c.dom.Element logonElement)
  

  Unmarshalls the Logon element. The following sample shows the structure of the Logon element and how it is unmarshalled.

  
    <Logon>
       <UserAccount> <!-- unmarshalled by unmarshallUserAccount() -->
         .
         .
       </UserAccount>
       <CommerceArea> <!-- unmarshalled by unmarshallCommerceArea() -->
         .
         .
       </CommerceArea>
       <BODFailure> <!-- unmarshalled by unmarshallBODFailure() -->
         .
         .
       </BodFailure>
       <BODSuccess> <!-- unmarshalled by unmarshallBODSuccess() -->
         .
         .
       </BODSuccess>
      <!-- unmarshalled by unmarshallUserData() -->
       <wc:UserData> <!-- optional -->
                          <wc:UserDataField name="name">value</wc:UserDataField>
                          .
                  </wc:UserData>
    </Logon>
  
   
  

  Parameters:

  operator - The data bean to populate.

  logonElement - The element that is unmarshalled.

  See Also:

  unmarshallUserAccount(Operator, Element), unmarshallCommerceArea(Operator, Element), TelesalesRequest.unmarshallBODFailure(Element), TelesalesRequest.unmarshallBODSuccess(Element), TelesalesRequest.unmarshallUserData(ModelObject, Element)

• unmarshallUserAccount

  protected void unmarshallUserAccount(Operator operator,
                           org.w3c.dom.Element userAccountElement)
  

  Unmarshalls the UserAccount element. The following sample shows the structure of the UserAccount element and how it is unmarshalled.

  
    <UserAccount>
       <SystemId> <!-- operator.setMemberId() -->
       <Authorization> <!-- unmarshalled by unmarshallAuthorization -->
          .
          .
       </Authorization>
    </UserAccount>
  
   
  

  Parameters:

  operator - The data bean to populate.

  userAccountElement - The element to unmarshall.

  See Also:

  unmarshallAuthorization(Operator, Element)

• unmarshallBusinessChannels

  protected void unmarshallBusinessChannels(org.w3c.dom.Element businessChannelsElement)
  

  Unmarshalls the BusinessChannel elements. Note: This method will add the list of Business Channels to the model. This method calls unmarshallBusinessChannel to unmarshall each of the BusinessChannel methods.

  Parameters:

  businessChannelsElement - The element to unmarshall.

  See Also:

  TelesalesModelManager.setBusinessChannels(BusinessChannel[])

• unmarshallBusinessChannel

  protected BusinessChannel unmarshallBusinessChannel(org.w3c.dom.Element businessChannelElement)
  

  Unmarshalls the BusinessChannel element. A new BusinessChannel object is constructed and populated with the information in the BusinessChannel element.

   
    <BusinessChannel>
       <BusinessChannelId/>   <!-- businessChannel.setChannelId() -->
       <BusinessChannelName/> <!-- businessChannel.setChannelName() -->
       <Description/>         <!-- businessChannel.setDescription() -->
       <Name/>                <!-- businessChannel.setDisplayName() -->
      <!-- unmarshalled by unmarshallUserData() -->
      <wc:UserData> <!-- optional -->
                  <wc:UserDataField name="name">value</wc:UserDataField>
                  .
            </wc:UserData>
    </BusinessChannel>
   
   
  

  Parameters:

  businessChannelElement - the BusinessChannel element

  Returns:

  the new BusinessChannel object

  See Also:

  TelesalesRequest.unmarshallUserData(ModelObject, Element)

• getRequestNodePathsToMask

  protected java.lang.String[] getRequestNodePathsToMask()
  

  The ProcessLogonRequest implementation returns the /ProcessLogon/DataArea/Logon/UserAccount/Authorization/Password value to be masked. This is because the password is sensitive information.

  Overrides:

  getRequestNodePathsToMask in class TelesalesRequest

  Returns:

  a String array containing the XPath expression /ProcessLogon/DataArea/Logon/UserAccount/Authorization/Password

  See Also:

  TelesalesRequest.getRequestNodePathsToMask()

• getResponseNodePathsToMask

  protected java.lang.String[] getResponseNodePathsToMask()
  

  The ProcessLogonRequest implementation returns the /AcknowledgeLogon/DataArea/Logon/UserAccount/Authorization/Password value to be masked. This is because the password is sensitive information.

  Overrides:

  getResponseNodePathsToMask in class TelesalesRequest

  Returns:

  a String array containing the XPath expression /AcknowledgeLogon/DataArea/Logon/UserAccount/Authorization/Password

  See Also:

  TelesalesRequest.getResponseNodePathsToMask()

• updateModel

  protected void updateModel(java.lang.Object databean)
  

  Update the model (com.ibm.commerce.telesales.model.TelesalesModelManager) prior to the UI being notified of the completion of the service request. This method will update the active operator with the new Operator object and call getCountries() to retrieve the list of countries.

  Overrides:

  updateModel in class OperatorRequest

  Parameters:

  databean - The data bean containing the model changes.

  See Also:

  TelesalesRequest.updateModel(java.lang.Object), getCountries()

• getCountries

  protected void getCountries()
  

  If the countries have not been retrieved, then get the countries.

  This method invokes "com.ibm.commerce.telesales.findCountry" service requests to the server and retrieves the list of countries.

  See Also:

  GetCountryRequest