public class AcknowledgeLogon extends TelesalesResponseBuilderImpl
This class can be extended by any sub-class to override or extend the base features.
Modifier and Type | Field and Description |
---|---|
static java.lang.String | CLASSNAME
Class Name
|
static java.lang.String | COPYRIGHT
IBM Copyright notice field
|
protected org.w3c.dom.Element | iAcknowledgeElement
The iAcknowledgeElement contains the response document's Acknowledge element.
|
protected org.w3c.dom.Element | iAuthorizationElement
The iAuthorizationElement contains the response document's Authorization element.
|
protected org.w3c.dom.Element | iAvailStoresElement
The iAvailStoresElement contains the response document's AvailStores element.
|
protected org.w3c.dom.Element | iBusinessChannelsElement
The iBusinessChannelsElement contains the response document's BusinessChannels element.
|
protected org.w3c.dom.Element | iLogonElement
The iLogonElement contains the response document's Logon element.
|
protected org.w3c.dom.Element | iOverrideReasonCodesElement
The iOverrideReasonCodesElement contains the response document's OverrideReasonCodes element.
|
protected org.w3c.dom.Element | iStatusElement
The iStatusElement contains the response document's Status element.
|
protected org.w3c.dom.Element | iUserAccountElement
The iUserAccountElement contains the response document's UserAccount element.
|
protected org.w3c.dom.Element | iUserAreaElement
The iUserAreaElement contains the response document's UserArea element.
|
Constructor and Description |
---|
AcknowledgeLogon() |
Modifier and Type | Method and Description |
---|---|
protected void | buildDataArea()
Builds the Data Area subsection of the reply BOD.
|
protected org.w3c.dom.Element | createABodFailureElement(org.w3c.dom.Element parentElement)
Builds the BODFailure element.
|
protected org.w3c.dom.Element | createAcknowledgeElement()
Creates the Acknowledge element.
|
protected org.w3c.dom.Element | createAuthorizationElement()
Builds the Authorization element.
|
protected org.w3c.dom.Element | createBodSuccessElement(org.w3c.dom.Element parentElement)
Builds the BODSuccess element.
|
protected org.w3c.dom.Element | createBusinessChannelElement(java.util.List channelInfo)
Builds the BusinessChannel element from the specified business channel info(list).
|
protected org.w3c.dom.Element | createBusinessChannelsElement()
Builds the BusinessChannels element.
|
protected org.w3c.dom.Element | createCommerceAreaElement(org.w3c.dom.Element aParentElement)
Builds the CommerceArea element.
|
protected org.w3c.dom.Element | createErrorMessageElement(org.w3c.dom.Element parentElement)
Builds the ErrorMessage element.
|
protected org.w3c.dom.Element | createLanguagesElement(org.w3c.dom.Element aParentElement)
Builds the Langages element.
|
protected org.w3c.dom.Element | createLogonElement()
Builds the Logon element.
|
protected org.w3c.dom.Element | createSenderElementForApplicationArea()
Builds the Sender element for the ApplicationArea element.
|
protected org.w3c.dom.Element | createStatusElement()
Builds the Status element.
|
protected org.w3c.dom.Element | createUserAccountElement()
Builds the UserAccount element.
|
protected org.w3c.dom.Element | createUserAreaElement()
Creates the UserArea element.
|
protected org.w3c.dom.Element | createUserdataInBusinessChannelElement(java.util.List channelInfo, org.w3c.dom.Element businessChannelElement)
This is an empty method to create the UserData element for BusinessChannel.
|
protected org.w3c.dom.Element | createUserdataInLanguageElement(LanguageDataBean dbLanguage, org.w3c.dom.Element languageElement)
This is an empty method to create the UserData element for Language.
|
protected org.w3c.dom.Element | createUserdataInLogonElement(org.w3c.dom.Element iLogonElement)
This is an empty method to create the UserData element for Logon.
|
protected org.w3c.dom.Element | createWarningMessageElement(org.w3c.dom.Element parentElement)
Builds the WarningMessage element.
|
protected java.lang.String | determineRequestLogonTokenID()
Determine the logon Token ID of the logon request.
|
ITelesalesResponseCacheableCommand | getCacheableCommand()
Returns an initialized cacheable command.
|
protected java.lang.String | getRootElementName()
Gets the root element name of the response document.
|
public static final java.lang.String CLASSNAME
public static final java.lang.String COPYRIGHT
protected org.w3c.dom.Element iAcknowledgeElement
protected org.w3c.dom.Element iLogonElement
protected org.w3c.dom.Element iUserAccountElement
protected org.w3c.dom.Element iAuthorizationElement
protected org.w3c.dom.Element iStatusElement
protected org.w3c.dom.Element iUserAreaElement
protected org.w3c.dom.Element iAvailStoresElement
protected org.w3c.dom.Element iBusinessChannelsElement
protected org.w3c.dom.Element iOverrideReasonCodesElement
protected void buildDataArea() throws ECException
The following sample indicates the structure of the DataArea element and how it is constructed.
<DataArea> <Acknowledge> <!-- createAcknowledgeElement() --> . . </Acknowledge> <Logon> <!-- createLogonElement() --> . . </Logon> </DataArea>
protected org.w3c.dom.Element createAcknowledgeElement() throws ECException
The following sample indicates the structure of the Acknowledge element and how it is constructed.
<Acknowledge> <oa:Code>Accepted</oa:Code> <!-- Accepted/Rejected --> </Acknowledge>
protected org.w3c.dom.Element createLogonElement() throws ECException
The following sample indicates the structure of the Logon element and how it is constructed. Only one of either BodSuccess or BodFailure will actually be created.
<Logon> <UserAccount> <!-- createUserAccountElement --> . . </UserAccount> <CommerceArea> <!-- createCommerceAreaElement --> . . </CommerceArea> <BodSuccess> <!-- createBodSuccessElement --> . . </BodSuccess> <BodFailure> <!-- createBodFailureElement --> . . </BodFailure> <UserData> <!-- createUserdataInLogonElement(Element) --> <UserDataField name="Name">"Value"</UserDataField> <UserData/> </Logon>
protected org.w3c.dom.Element createUserdataInLogonElement(org.w3c.dom.Element iLogonElement) throws ECException
... Element userDataElement = createWCDocumentElement(iLogonElement, BodConstants.TAG_WC_USER_DATA); createUserDataFieldElement(userDataElement, fieldName, fieldValue); ... return userDataElement;
protected org.w3c.dom.Element createUserAccountElement() throws ECException
The following sample indicates the structure of the UserAccount element and how it is constructed.
<UserAccount> <UserAccount>101</UserAccount> <!-- user ID --> <Authorization> <!-- createAuthorizationElement --> . . </Authorization> <UserArea> <!-- createUserAreaElement --> . . </UserArea> </UserAccount>
protected org.w3c.dom.Element createAuthorizationElement() throws ECException
The following sample indicates the structure of the Authorization element and how it is constructed.
<Authorization> <oa:Id>LOGON_TOKEN_ID_SCAFFOLDING</oa:Id> <oa:Type/> <oa:Status> <!-- createStatusElement --> . . </oa:Status> <oa:EffectivePeriod/> <oa:UserArea/> <UserId>wcsadmin</UserId> <!-- logon ID --> </Authorization>
protected org.w3c.dom.Element createStatusElement() throws ECException
The following sample indicates the structure of the Status element and how it is constructed.
<oa:Status> <oa:Code/> <oa:Description/> <oa:Change/> <oa:UserArea/> </oa:Status>
protected org.w3c.dom.Element createUserAreaElement() throws ECException
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> <AvailStores> <!-- createAvailStoresElement --> . . </AvailStores> </BlockReasonCodes> <BusinessChannels> <!-- createBusinessChannelsElement --> . . </BusinessChannels> <Langages> <!-- createLanguagesElement --> . . </Langages> </CommerceArea>
protected org.w3c.dom.Element createLanguagesElement(org.w3c.dom.Element aParentElement) throws ECException
The following sample indicates the structure of the Languages element and how it is constructed.
<wc:Languages> <wc:Language> <wc:LanguageId>-7</wc:LanguageId> <wc:LanguageDescription>English</wc:LanguageDescription> <UserData> <!-- createUserdataInLanguageElement(LanguageDataBean, Element) --> <UserDataField name="Name">"Value"</UserDataField> <UserData/> </wc:Language> . . <wc:Language> ... </wc:Language> </wc:Languages>
protected org.w3c.dom.Element createUserdataInLanguageElement(LanguageDataBean dbLanguage, org.w3c.dom.Element languageElement) throws ECException
... Element userDataElement = createWCDocumentElement(languageElement, BodConstants.TAG_WC_USER_DATA); createUserDataFieldElement(userDataElement, fieldName, fieldValue); ... return userDataElement;
protected org.w3c.dom.Element createBusinessChannelsElement() throws ECException
The following sample indicates the structure of the BusinessChannels element and how it is constructed.
<BusinessChannels> <BusinessChannel> <!-- createBusinessChannelElement --> . . </BusinessChannel> <BusinessChannel> <!-- createBusinessChannelElement --> . . </BusinessChannel> </BusinessChannels>
protected org.w3c.dom.Element createBusinessChannelElement(java.util.List channelInfo)
The following sample indicates the structure of the BusinessChannel element and how it is constructed.
<wc:BusinessChannel> <wc:BusinessChannelId>-1</wc:BusinessChannelId> <wc:Name>Web Channel</wc:Name> <wc:Description>Used when operations performed from a desktop browser.</wc:Description> <UserData> <!-- createUserdataInBusinessChannelElement(List, Element) --> <UserDataField name="Name">"Value"</UserDataField> <UserData/> </wc:BusinessChannel>
protected org.w3c.dom.Element createUserdataInBusinessChannelElement(java.util.List channelInfo, org.w3c.dom.Element businessChannelElement) throws ECException
... Element userDataElement = createWCDocumentElement(businessChannelElement, BodConstants.TAG_WC_USER_DATA); createUserDataFieldElement(userDataElement, fieldName, fieldValue); ... return userDataElement;
protected org.w3c.dom.Element createBodSuccessElement(org.w3c.dom.Element parentElement) throws ECException
The following sample indicates the structure of the BODSuccess element and how it is constructed.
<wc:BODSuccess> <wc:WarningMessage> <!-- createWarningMessageElement --> . . </wc:WarningMessage> </wc:BODSuccess>
protected org.w3c.dom.Element createWarningMessageElement(org.w3c.dom.Element parentElement) throws ECException
The following sample indicates the structure of the BODFailure element and how it is constructed.
<wc:WarningMessage> <oa:Description>This is a warning message.</oa:Description> <oa:ReasonCode>0000</oa:ReasonCode> </wc:WarningMessage>
protected org.w3c.dom.Element createABodFailureElement(org.w3c.dom.Element parentElement) throws ECException
The following sample indicates the structure of the BODFailure element and how it is constructed.
<wc:BODFailure> <wc:ErrorMessage> <!-- createErrorMessageElement --> . . </wc:ErrorMessage> </wc:BODFailure>
protected org.w3c.dom.Element createErrorMessageElement(org.w3c.dom.Element parentElement) throws ECException
The following sample indicates the structure of the BODFailure element and how it is constructed.
<wc:ErrorMessage> <oa:Description>An error has occurred.</oa:Description> <oa:ReasonCode>100</oa:ReasonCode> </wc:ErrorMessage>
protected java.lang.String getRootElementName()
protected org.w3c.dom.Element createSenderElementForApplicationArea() throws ECException
protected java.lang.String determineRequestLogonTokenID()
public ITelesalesResponseCacheableCommand getCacheableCommand() throws ECException