public abstract class Customer extends TelesalesResponseBuilderImpl implements ITelesalesResponseBuilder
Modifier and Type | Field and Description |
---|---|
static java.lang.String | CLASSNAME
Class name field.
|
static java.lang.String | COPYRIGHT
IBM Copyright notice field.
|
Constructor and Description |
---|
Customer()
Default Constructor.
|
Modifier and Type | Method and Description |
---|---|
protected org.w3c.dom.Element | buildCustomerElementBaseInfo(CustomerSearchResultBean abnCustomerSearchResult, org.w3c.dom.Element aParentElement)
This method builds the Customer element with the base information.
|
protected org.w3c.dom.Element | buildCustomerElementDetailInfo(CustomerSearchResultBean abnCustomerSearchResult, org.w3c.dom.Element aParentElement)
This method builds the Customer element which contains the detailed information.
|
org.w3c.dom.Element | createAddressElement(AddressDataBean abnUserAddress, boolean aboolIfPrimary, org.w3c.dom.Element aParentElement)
This method builds the Address element.
|
protected org.w3c.dom.Element | createAddressesElement(CustomerSearchResultBean abnCustomerSearchResult, org.w3c.dom.Element aParentElement)
This method builds the Addresses element.
|
protected org.w3c.dom.Element | createAddressesElementBaseInfo(CustomerSearchResultBean abnCustomerSearchResult, org.w3c.dom.Element aParentElement)
This method creates an Addresses element using the base addresses information.
|
void | createAssignedRepresentativeElements(CustomerSearchResultBean abnCustomerSearchResult, org.w3c.dom.Element aParentElement)
This method builds the AssignedRepresentative elements.
|
void | createAssignedTeamElements(CustomerSearchResultBean abnCustomerSearchResult, org.w3c.dom.Element aParentElement)
This method builds the AssignedTeam elements.
|
protected org.w3c.dom.Element | createAuthorizationElement(CustomerSearchResultBean abnCustomerSearchResult, org.w3c.dom.Element aParentElement)
This method builds the Authorization element.
|
org.w3c.dom.Element | createBusinessElement(CustomerSearchResultBean abnCustomerSearchResult, org.w3c.dom.Element aParentElement)
This method creates the Business element.
|
org.w3c.dom.Element | createContactElement(CustomerSearchResultBean abnCustomerSearchResult, org.w3c.dom.Element aParentElement, boolean aboolBuiltUserAccountInformation)
This method builds the Contact element.
|
protected org.w3c.dom.Element | createContactsElement(CustomerSearchResultBean abnCustomerSearchResult, org.w3c.dom.Element aParentElement)
This method builds the Contacts element.
|
protected org.w3c.dom.Element | createContactsElementBaseInfo(CustomerSearchResultBean abnCustomerSearchResult, org.w3c.dom.Element aParentElement)
This method builds the Contacts element with the base information.
|
protected org.w3c.dom.Element | createCustomerDemographicsElement(CustomerSearchResultBean abnCustomerSearchResult, org.w3c.dom.Element aParentElement)
This method builds the CustomerDemographics element.
|
protected org.w3c.dom.Element | createCustomerElement(CustomerSearchResultBean abnCustomerSearchResult, org.w3c.dom.Element aParentElement)
This method builds the Customer element.
|
org.w3c.dom.Element | createCustomerPartyElement(CustomerSearchResultBean abnCustomerSearchResult, org.w3c.dom.Element aParentElement)
This method builds the CustomerParty element.
|
protected org.w3c.dom.Element | createCustomerPartyElementBaseInfo(CustomerSearchResultBean abnCustomerSearchResult, org.w3c.dom.Element aParentElement)
This method builds the CustomerParty Element.
|
protected org.w3c.dom.Element | createPersonElement(CustomerSearchResultBean abnCustomerSearchResult, org.w3c.dom.Element aParentElement)
This method builds the Person element.
|
protected org.w3c.dom.Element | createPersonElementBaseInfo(CustomerSearchResultBean abnCustomerSearchResult, org.w3c.dom.Element aParentElement)
This method builds the Person element with the base information.
|
protected org.w3c.dom.Element | createPersonNameElement(CustomerSearchResultBean abnCustomerSearchResult, org.w3c.dom.Element aParentElement)
This method builds the PersonName element.
|
protected org.w3c.dom.Element | createTelephoneElement(org.w3c.dom.Element aParentElement, java.lang.String astrPhoneNumber, java.lang.String astrPhoneType, java.lang.String astrPublishPhone)
This method creates the Telephone element.
|
protected org.w3c.dom.Element | createUserAccountElement(CustomerSearchResultBean abnCustomerSearchResult, org.w3c.dom.Element aParentElement)
This method builds the UserAccount element.
|
protected org.w3c.dom.Element | createUserDataElement(AddressDataBean abnAddress, org.w3c.dom.Element aParentElement)
This method creates the user data element for the address element.
|
protected org.w3c.dom.Element | createUserDataElement(CustomerSearchResultBean abnCustomerSearchResult, org.w3c.dom.Element aParentElement)
This method creates the user data element for the customer element.
|
protected org.w3c.dom.Element | createUserdataInAssignedRepresentativeElement(UserRegistryDataBean dbUserReg, CustomerSearchResultBean abnCustomerSearchResult, org.w3c.dom.Element customerAssignedRepresentativeElement)
This is an empty method to create the UserData element for AssignedRepresentative.
|
protected org.w3c.dom.Element | createUserdataInAssignedTeamElement(MemberGroupAccessBean abMbrGrp, CustomerSearchResultBean abnCustomerSearchResult, org.w3c.dom.Element customerAssignedTeamElement)
This is an empty method to create the UserData element for AssignedTeam.
|
protected org.w3c.dom.Element | createUserdataInBusinessElement(com.ibm.commerce.user.beans.OrgEntityDataBean bnOrgEntity, CustomerSearchResultBean abnCustomerSearchResult, org.w3c.dom.Element businessElement)
This is an empty method to create the UserData element for Business.
|
protected CustomerSearchResultBean | populateAddressBook(CustomerSearchResultBean abnSearchResult)
This method populates the address book for the given registered customer.
|
protected CustomerSearchResultBean | populateAddressDetails(java.lang.String astrUserId, CustomerSearchResultBean abnSearchResult, boolean aboolGetDetails)
This method populates the address of the user into the search result bean.
|
protected CustomerSearchResultBean | populateOrgEntity(CustomerSearchResultBean abnSearchResult)
This method populates the OrgEntityDataBean databean for the given registered customer.
|
protected CustomerSearchResultBean | populatePrimaryAddress(CustomerSearchResultBean abnSearchResult)
This method populates the AddressDataBean databean for the given customer.
|
protected CustomerSearchResultBean | populateSearchResult(java.util.List addressIds, CustomerSearchResultBean abnSearchResult)
This method populates the search result for the given list of addresses.
|
protected CustomerSearchResultBean | populateSearchResult(java.lang.String astrUserId, CustomerSearchResultBean abnSearchResult, boolean aboolGetDetails)
This method populates the search result for the given customer.
|
protected CustomerSearchResultBean | populateUser(java.lang.String astrUserId, CustomerSearchResultBean abnSearchResult)
This method populates the UserDataBean databean for the given customer.
|
protected CustomerSearchResultBean | populateUserProfile(CustomerSearchResultBean abnSearchResult)
This method populates the UserProfileDataBean databean for the given registered customer.
|
protected CustomerSearchResultBean | populateUserRegistration(java.lang.String astrUserId, CustomerSearchResultBean abnSearchResult)
This method populates the UserRegistrationDataBean databean for the given customer.
|
protected CustomerSearchResultBean | populateUserRegistry(CustomerSearchResultBean abnSearchResult)
This method populates the UserRegistryDataBean databean for the given registered customer.
|
public static final java.lang.String CLASSNAME
public static final java.lang.String COPYRIGHT
public org.w3c.dom.Element createAddressElement(AddressDataBean abnUserAddress, boolean aboolIfPrimary, org.w3c.dom.Element aParentElement) throws ECException
<Address primary="true" type="SB"> <AddressId/> <!-- abnUserAddress.getAddressId() --> <AddressLine/> <!-- abnUserAddress.getAddress1() --> <AddressLine/> <!-- abnUserAddress.getAddress2() --> <AddressLine/> <!-- abnUserAddress.getAddress3() --> <City/> <!-- abnUserAddress.getCity() --> <PostalCode/> <!-- abnUserAddress.getZipCode() --> <StateOrProvinceCode/> <!-- abnUserAddress.getState() --> <CountryCode/> <!-- abnUserAddress.getCountry() --> <AddressNickName/> <!-- abnUserAddress.getNickName() --> <UserData/> <!-- createUserDataElement() --> </Address>
protected org.w3c.dom.Element createUserDataElement(AddressDataBean abnAddress, org.w3c.dom.Element aParentElement) throws ECException
protected org.w3c.dom.Element createAddressesElement(CustomerSearchResultBean abnCustomerSearchResult, org.w3c.dom.Element aParentElement) throws ECException
protected org.w3c.dom.Element createPersonElement(CustomerSearchResultBean abnCustomerSearchResult, org.w3c.dom.Element aParentElement) throws ECException
This method invokes the createPersonNameElement to create the PersonName element as a child of the Person element.
protected org.w3c.dom.Element createPersonNameElement(CustomerSearchResultBean abnCustomerSearchResult, org.w3c.dom.Element aParentElement) throws ECException
The following is a sample PersonName element that indicates how the element is constructed. The specified CustomerSearchResultBean is expected to contain an instance of UserProfileDataBean and an instance of AddressDataBean.
<oa:PersonName> <oa:Salutation>Ms</oa:Salutation> <!-- bnUserAddress.getPersonTitle() --> <oa:GivenName>helen</oa:GivenName> <!-- bnUserAddress.getFirstName() --> <oa:PreferredGivenName>helen</oa:PreferredGivenName> <!-- bnUserAddress.getNickName() --> <oa:MiddleName>a</oa:MiddleName> <!-- bnUserAddress.getMiddleName() --> <oa:FamilyName>yang</oa:FamilyName> <!-- bnUserAddress.getLastName() --> <oa:Suffix></oa:Suffix> <oa:FormattedName>Ms helen yang</oa:FormattedName> <!-- bnUserProfileDataBean.getDisplayName(); --> </oa:PersonName>
protected org.w3c.dom.Element createTelephoneElement(org.w3c.dom.Element aParentElement, java.lang.String astrPhoneNumber, java.lang.String astrPhoneType, java.lang.String astrPublishPhone) throws ECException
<Telephone type="PHN" publish="1">555-1234</Telephone>
public org.w3c.dom.Element createContactElement(CustomerSearchResultBean abnCustomerSearchResult, org.w3c.dom.Element aParentElement, boolean aboolBuiltUserAccountInformation) throws ECException
This method calls createPersonElement to create the Person element.
If the user account information needs to be built, it will call createUserAccountElement to create the UserAccount.
The following is a sample Contact element that indicates how the element is constructed:
<Contact> <oa:Person> <!-- created by the createPersonElement method --> . . </oa:Person> <oa:EMailAddress>helen@ca.ibm.com</oa:EMailAddress> <!-- bnUserAddress.getEmail1() --> <oa:EMailAddress>helen2@ca.ibm.com</oa:EMailAddress> <!-- bnUserAddress.getEmail2() --> <oa:Fax>1234567</oa:Fax> <!-- bnUserAddress.getFax1() --> <oa:Fax>8904566</oa:Fax> <!-- bnUserAddress.getFax2() --> <Telephone publish="0" type=""> <!-- created by the createTelephoneElement method --> . . </Telephone> <Telephone publish="0" type=""> <!-- created by the createTelephoneElement method --> . . </Telephone> <BestCallTime/> <!-- bnUserAddress.getBestCallingTime() --> <UserAccount> <!-- created by the createUserAccountElement method when the user account information is required --> . . </UserAccount> </Contact>
protected org.w3c.dom.Element createContactsElement(CustomerSearchResultBean abnCustomerSearchResult, org.w3c.dom.Element aParentElement) throws ECException
<Contacts> <Contact> <!-- createContactElement() --> . . </Contact> </Contacts>
protected org.w3c.dom.Element createCustomerDemographicsElement(CustomerSearchResultBean abnCustomerSearchResult, org.w3c.dom.Element aParentElement) throws ECException
<CustomerDemographics> <Age/> <!-- bnUserRegistration.getAge() --> <Gender/> <!-- bnUserRegistration.getGender() --> <AnnualIncome/> <!-- bnUserRegistration.getIncome() --> <MaritalStatus/> <!-- bnUserRegistration.getMaritalStatus() --> <NumberOfChildren/> <!-- bnUserRegistration.getNumberOfChildren() --> <NumberInHousehold/> <!-- bnUserRegistration.getHousehold() --> <Employer/> <!-- bnUserRegistration.getCompanyName() --> <Department/> <!-- bnUserRegistration.getDepartmentNumber() --> <BusinessTitle/> <!-- bnUserRegistration.getBusinessTitle() --> <InterestHobby/> <!-- bnUserRegistration.getHobbies() --> </CustomerDemographics>
public org.w3c.dom.Element createBusinessElement(CustomerSearchResultBean abnCustomerSearchResult, org.w3c.dom.Element aParentElement) throws ECException
The following is a sample Business element that indicates how the element is constructed. The Business element will only be created if the specified CustomerSearchResultBean contains an instance of OrgEntityDataBean.
<oa:Business> <oa:Function>O</oa:Function> <!-- bnOrgEntity.getOrgEntityType() --> <oa:Name></oa:Name> <!-- bnOrgEntity.getBusinessCategory() --> <oa:RelatedUnit> <oa:Relationship>Parent</oa:Relationship> <oa:Unit> <oa:Id>-2000</oa:Id> <!-- bnOrgEntity.getOrgEntityId() --> <oa:Name>Default Organization</oa:Name> <!-- bnOrgEntity.getOrgEntityName() --> </oa:Unit> </oa:RelatedUnit> <UserData> <!-- createUserdataInBusinessElement(OrgEntityDataBean, CustomerSearchResultBean, Element) --> <UserDataField name="Name">"Value"</UserDataField> <UserData/> </oa:Business>
protected org.w3c.dom.Element createUserdataInBusinessElement(com.ibm.commerce.user.beans.OrgEntityDataBean bnOrgEntity, CustomerSearchResultBean abnCustomerSearchResult, org.w3c.dom.Element businessElement) throws ECException
... Element userDataElement = createWCDocumentElement(businessElement, abnCustomerSearchResult, BodConstants.TAG_WC_USER_DATA); createUserDataFieldElement(userDataElement, fieldName, fieldValue); ... return userDataElement;
public org.w3c.dom.Element createCustomerPartyElement(CustomerSearchResultBean abnCustomerSearchResult, org.w3c.dom.Element aParentElement) throws ECException
This method calls the following methods to create the child elements:
<CustomerParty> <PartyId/> <Business/> <Addresses/> <Contacts/> </CustomerParty>
protected org.w3c.dom.Element createAuthorizationElement(CustomerSearchResultBean abnCustomerSearchResult, org.w3c.dom.Element aParentElement) throws ECException
<Authorization> <Status> <Code>1</Code> <!-- bnUserRegistry.getStatus() --> </Status> <Password/> <!-- bnUserRegistry.getLogonPassword() --> <UserId/> <!-- bnUserRegistry.getLogonId() --> <VerifyPassword/> <!-- bnUserRegistry.getLogonPassword() --> <ChallengeQuestion/> <!-- bnUserRegistry.getChallengeQuestion() --> <ChallengeAnswer/> <!-- bnUserRegistry.getChallengeAnswer() --> </Authorization>
protected org.w3c.dom.Element createUserAccountElement(CustomerSearchResultBean abnCustomerSearchResult, org.w3c.dom.Element aParentElement) throws ECException
<UserAccount> <Authorization/> >!-- createAuthorizationElement() --< </UserAccount>
protected org.w3c.dom.Element createCustomerElement(CustomerSearchResultBean abnCustomerSearchResult, org.w3c.dom.Element aParentElement) throws ECException
If the order detailed information is needed (abnCustomerSearchResult.getRetrieveDetailsFlag returns true. ), this method calls the buildCustomerElementDetailInfo method to build the elements. Otherwise, this method calls the buildCustomerElementBaseInfo method to build the elements.
protected org.w3c.dom.Element createUserDataElement(CustomerSearchResultBean abnCustomerSearchResult, org.w3c.dom.Element aParentElement) throws ECException
protected org.w3c.dom.Element buildCustomerElementDetailInfo(CustomerSearchResultBean abnCustomerSearchResult, org.w3c.dom.Element aParentElement) throws ECException
<Customer> <CustomerParty/> <CommerceArea/> <CustomerDemographics/> <AssignedTeam/> <AssignedRepresentative/> </Customer>
protected org.w3c.dom.Element buildCustomerElementBaseInfo(CustomerSearchResultBean abnCustomerSearchResult, org.w3c.dom.Element aParentElement) throws ECException
<Customer> <CustomerParty/> <CommerceArea/> </Customer>
protected org.w3c.dom.Element createCustomerPartyElementBaseInfo(CustomerSearchResultBean abnCustomerSearchResult, org.w3c.dom.Element aParentElement) throws ECException
This method calls the following methods to create the child elements:
<CustomerParty> <PartyId/> <Business/> <Addresses/> <Contacts/> </CustomerParty>
protected org.w3c.dom.Element createAddressesElementBaseInfo(CustomerSearchResultBean abnCustomerSearchResult, org.w3c.dom.Element aParentElement) throws ECException
The following is a sample Addresses element that indicates how the element is constructed:
<Addresses> <Address primary="true" type="SB"> <oa:AddressId>11801</oa:AddressId> <oa:AddressLine>1234 John Street</oa:AddressLine> <AddressNickName>helen</AddressNickName> </Address> </Addresses>
protected org.w3c.dom.Element createContactsElementBaseInfo(CustomerSearchResultBean abnCustomerSearchResult, org.w3c.dom.Element aParentElement) throws ECException
The following is a sample Contacts element that indicates how the element is constructed:
<Contacts> <Contact> <Person> <!-- created by the createPersonElementBaseInfo method --> ........ ........ </Person> <UserAccount> <Authorization> <UserId>Alan</UserId> </Authorization> </UserAccount> </Contact> </Contacts>
protected org.w3c.dom.Element createPersonElementBaseInfo(CustomerSearchResultBean abnCustomerSearchResult, org.w3c.dom.Element aParentElement) throws ECException
The following is a sample Person element that indicates how the element is constructed:
<oa:Person> <oa:PersonCode>String</oa:PersonCode> <oa:PersonName> <oa:GivenName>helen</oa:GivenName> <oa:FamilyName>yang</oa:FamilyName> </oa:PersonName> </oa:Person>
public void createAssignedTeamElements(CustomerSearchResultBean abnCustomerSearchResult, org.w3c.dom.Element aParentElement) throws ECException
<AssignedTeam> <PartyId/> <!-- createPartyIdElement --> <Name/> <UserData> <!-- createUserdataInAssignedTeamElement(MemberGroupAccessBean, CustomerSearchResultBean, Element) --> <UserDataField name="Name">"Value"</UserDataField> <UserData/> </AssignedTeam>
protected org.w3c.dom.Element createUserdataInAssignedTeamElement(MemberGroupAccessBean abMbrGrp, CustomerSearchResultBean abnCustomerSearchResult, org.w3c.dom.Element customerAssignedTeamElement) throws ECException
... Element userDataElement = createWCDocumentElement(customerAssignedTeamElement, BodConstants.TAG_WC_USER_DATA); createUserDataFieldElement(userDataElement, fieldName, fieldValue); ... return userDataElement;
public void createAssignedRepresentativeElements(CustomerSearchResultBean abnCustomerSearchResult, org.w3c.dom.Element aParentElement) throws ECException
<AssignedRepresentative> <PartyId/> <!-- createPartyIdElement --> <Name/> <UserData> <!-- createUserdataInAssignedRepresentativeElement(UserRegistryAccessBean, Element) --> <UserDataField name="Name">"Value"</UserDataField> <UserData/> </AssignedAssignedRepresentative>
protected org.w3c.dom.Element createUserdataInAssignedRepresentativeElement(UserRegistryDataBean dbUserReg, CustomerSearchResultBean abnCustomerSearchResult, org.w3c.dom.Element customerAssignedRepresentativeElement) throws ECException
... Element userDataElement = createWCDocumentElement(customerAssignedRepresentativeElement, BodConstants.TAG_WC_USER_DATA); createUserDataFieldElement(userDataElement, fieldName, fieldValue); ... return userDataElement;
protected CustomerSearchResultBean populateSearchResult(java.util.List addressIds, CustomerSearchResultBean abnSearchResult) throws ECException
This method initializes and activates the following data bean:
protected CustomerSearchResultBean populateSearchResult(java.lang.String astrUserId, CustomerSearchResultBean abnSearchResult, boolean aboolGetDetails) throws ECException
When the aboolGetDetails is true, this method initializes and activates the following databeans for the given customer:
When the aboolGetDetails is false, this method initializes and activates the following databeans for the given customer:
protected CustomerSearchResultBean populateUser(java.lang.String astrUserId, CustomerSearchResultBean abnSearchResult) throws ECException
protected CustomerSearchResultBean populateUserRegistration(java.lang.String astrUserId, CustomerSearchResultBean abnSearchResult) throws ECException
protected CustomerSearchResultBean populatePrimaryAddress(CustomerSearchResultBean abnSearchResult) throws ECException
protected CustomerSearchResultBean populateAddressBook(CustomerSearchResultBean abnSearchResult) throws ECException
protected CustomerSearchResultBean populateUserRegistry(CustomerSearchResultBean abnSearchResult) throws ECException
protected CustomerSearchResultBean populateOrgEntity(CustomerSearchResultBean abnSearchResult) throws ECException
protected CustomerSearchResultBean populateUserProfile(CustomerSearchResultBean abnSearchResult) throws ECException
protected CustomerSearchResultBean populateAddressDetails(java.lang.String astrUserId, CustomerSearchResultBean abnSearchResult, boolean aboolGetDetails) throws ECException