public class GetStoreRequest extends StoreRequest
Modifier and Type | Field and Description |
---|---|
protected org.w3c.dom.Element | storeElement_
storeElement_ contains the request document's Store element.
|
Constructor and Description |
---|
GetStoreRequest() |
Modifier and Type | Method and Description |
---|---|
protected org.w3c.dom.Element | createDataAreaElement()
Builds the DataArea element and adds it as a child of rootElement_.
|
protected org.w3c.dom.Element | createSenderElement()
Builds the Sender element and adds it as a child of applicationAreaElement_.
|
protected org.w3c.dom.Element | createStoreElement()
Builds the Store element and adds it as a child of dataAreaElement_.
|
protected org.w3c.dom.Document | getRequestBod()
Constructs the request document.
|
protected Session | getResponseData()
Returns the unmarshalled response data in the form of a com.ibm.commerce.telesales.model.GenericGet object.
|
ServiceContext | getServiceContext()
Returns the ServiceContext object specific to this request.
|
protected java.lang.String | getXSDFileName()
Returns the name of the schema file for the request BOD.
|
protected void | unmarshallAvailableOrderChangeReasonsElement(org.w3c.dom.Element reasonsElement, Store store)
Unmarshalls the AvailableOrderChangeReasons element.
|
protected void | unmarshallAvailableReturnReasonsElement(org.w3c.dom.Element reasonsElement, Store store)
Unmarshalls the AvailableReturnReasons element.
|
protected void | unmarshallAvailShippingModes(org.w3c.dom.Element availShippingModesElement, Store newStore)
Unmarshalls the AvailShippingModes element.
|
protected void | unmarshallAvailTicklerActions(org.w3c.dom.Element availTicklerActionsElement, Store newStore)
Unmarshalls the AvailTicklerActions element.
|
protected void | unmarshallAvailTicklerReasons(org.w3c.dom.Element availTicklerReasonsElement, Store newStore)
Unmarshalls the AvailTicklerReasons element.
|
protected void | unmarshallBlockReasonCodes(org.w3c.dom.Element blockReasonCodesElement, Store store)
Unmarshalls the BlockReasonCode element.
|
protected ChargeType | unmarshallChargeType(org.w3c.dom.Element chargeTypeElement, Store newStore)
Unmarshalls the ChargeType element.
|
protected void | unmarshallChargeTypes(org.w3c.dom.Element chargeTypesElement, Store newStore)
Unmarshalls the ChargeTypes element.
|
protected Currency | unmarshallCurrency(org.w3c.dom.Element currencyElement, Store newStore)
Unmarshalls the Currency element.
|
protected void | unmarshallDataArea(org.w3c.dom.Element dataAreaElement)
Unmarshalls the DataArea element.
|
protected OverrideReason | unmarshallOverrideReasonCode(org.w3c.dom.Element reasonCodeElement, Store newStore)
Unmarshalls the OverrideReasonCode element.
|
protected void | unmarshallOverrideReasonCodes(org.w3c.dom.Element reasonCodesElement, Store newStore)
Unmarshalls the OverrideReasonCodes element.
|
protected Organization | unmarshallOwner(Store newStore, org.w3c.dom.Element ownerElement)
Unmarshalls the Owner element.
|
protected void | unmarshallRelatedUnit(Organization organization, org.w3c.dom.Element relatedUnitElement)
Unmarshalls the RelatedUnit element.
|
protected void | unmarshallResponseBod(org.w3c.dom.Document bod)
Unmarshalls the response BOD.
|
protected Role | unmarshallRole(org.w3c.dom.Element roleElement, Store newStore)
Unmarshalls the Role element.
|
protected void | unmarshallRoles(org.w3c.dom.Element rolesElement, Store newStore)
Unmarshalls the Roles element.
|
protected ShippingMode | unmarshallShippingMode(org.w3c.dom.Element shippingModeElement, Store newStore)
Unmarshalls the ShippingMode element.
|
protected void | unmarshallShowStore(GenericGet get, org.w3c.dom.Element showStoreElement)
Unmarshalls the ShowStore element.
|
protected void | unmarshallStore(Store newStore, org.w3c.dom.Element storeElement)
Unmarshalls the Store element.
|
protected void | unmarshallSupportedCurrencies(org.w3c.dom.Element supportedCurrenciesElement, Store newStore)
Unmarshalls the SupportedCurrencies element.
|
protected void | unmarshallSupportedLanguages(org.w3c.dom.Element supportedLanguagesElement, Store newStore)
Unmarshalls the SupportedLanguages element.
|
protected TicklerActionCode | unmarshallTicklerActionCode(org.w3c.dom.Element ticklerActionCodeElement, Store newStore)
Unmarshalls the TicklerActionCode element.
|
protected void | unmarshallTicklerCodes(org.w3c.dom.Element ticklerCodesElement, Store newStore)
Unmarshalls the TicklerCodes element.
|
protected TicklerReasonCode | unmarshallTicklerReasonCode(org.w3c.dom.Element ticklerReasonCodeElement, Store newStore)
Unmarshalls the TicklerReasonCode element.
|
protected void | unmarshallUnit(Organization organization, org.w3c.dom.Element unitElement)
Unmarshalls the Unit element.
|
protected org.w3c.dom.Element storeElement_
protected Session getResponseData()
public ServiceContext getServiceContext()
protected java.lang.String getXSDFileName()
protected org.w3c.dom.Document getRequestBod()
<GetStore> <!-- created by the createWCRootElement method --> . . </GetStore>
protected org.w3c.dom.Element createDataAreaElement()
The following outline indicates the structure of the DataArea element and how it is constructed:
<DataArea> <Get> <!-- constructed by createGetElement() --> . . </Get> <Store> <!-- constructed by createStoreElement() --> . . </Store> </DataArea>
protected org.w3c.dom.Element createStoreElement()
The following outline indicates the structure of the Store element and how it is constructed:
<Store> <CommerceArea> <!-- constructed by createCommerceAreaElement() --> . . </CommerceArea> </Store>
protected org.w3c.dom.Element createSenderElement()
The following sample Sender element indicates how the element is constructed:
<oa:Sender> <oa:LogicalId>TSCLIENT</oa:LogicalId> <oa:Component>Store</oa:Component> <oa:Task>GetStore</oa:Task> <oa:ReferenceId>-1680589954192190044</oa:ReferenceId> <!-- value of getActionCtx --> <oa:Confirmation>2</oa:Confirmation> <oa:AuthorizationId>LOGON_TOKEN_ID_SCAFFOLDING</oa:AuthorizationId> <!-- value of ContextManager.getInstance().getSessionCtx() --> </oa:Sender>
protected void unmarshallOverrideReasonCodes(org.w3c.dom.Element reasonCodesElement, Store newStore)
<OverrideReasonCodes> <OverrideReasonCode> <-- unmarshalled by unmarshallOverrideReasonCode() --> <ReasonCode>10000</ReasonCode> <Description>Description :0</Description> </OverrideReasonCode> <OverrideReasonCode> <ReasonCode>10001</ReasonCode> <Description>Description :1</Description> </OverrideReasonCode> <OverrideReasonCode> <ReasonCode>10002</ReasonCode> <Description>Description :2</Description> </OverrideReasonCode> </OverrideReasonCodes>
protected OverrideReason unmarshallOverrideReasonCode(org.w3c.dom.Element reasonCodeElement, Store newStore)
<OverrideReasonCode> < <ReasonCode>1000</ReasonCode> <Description>Description :0</Description> <!-- unmarshalled by unmarshallUserData() --> <wc:UserData> <!-- optional --> <wc:UserDataField name="name">value</wc:UserDataField> . </wc:UserData> </OverrideReasonCode>
protected void unmarshallResponseBod(org.w3c.dom.Document bod)
protected void unmarshallShowStore(GenericGet get, org.w3c.dom.Element showStoreElement)
<ShowStore> <oa:ApplicationArea> <!-- unmarshalled by unmarshallApplicationArea() --> . . </oa:ApplicationArea> <DataArea> <!-- unmarshalled by unmarshallDataArea() --> . . </DataArea> </ShowStore>
protected void unmarshallAvailShippingModes(org.w3c.dom.Element availShippingModesElement, Store newStore)
<AvailShippingModes> <ShippingMode> <!-- unmarshalled by unmarshallShippingMode() --> <ModeId>10051</ModeId> <ModeDescription>International mail</ModeDescription> </ShippingMode> <ShippingMode> <!-- unmarshalled by unmarshallShippingMode() --> <ModeId>10052</ModeId> <ModeDescription>Express mail</ModeDescription> </ShippingMode> <ShippingMode> <!-- unmarshalled by unmarshallShippingMode() --> <ModeId>10053</ModeId> <ModeDescription>Courier</ModeDescription> </ShippingMode> </AvailShippingModes>
protected void unmarshallChargeTypes(org.w3c.dom.Element chargeTypesElement, Store newStore)
<ChargeTypes> <ChargeType> <!-- unmarshalled by unmarshallChargeType() --> <ChargeTypeId>-7002</ChargeTypeId> <Description>Shipping charged by carrier</Description> </ChargeType> <ChargeType> <!-- unmarshalled by unmarshallChargeType() --> <ChargeTypeId>-7001</ChargeTypeId> <Description>Shipping charged by seller</Description> </ChargeType> </ChargeTypes>
protected ChargeType unmarshallChargeType(org.w3c.dom.Element chargeTypeElement, Store newStore)
<ChargeType> <ChargeTypeId>-7001</ChargeTypeId> <!-- chargeType.setChargeTypeId() --> <Description>Shipping charged by carrier</Description> <!-- chargeType.setDescription() --> <!-- unmarshalled by unmarshallUserData() --> <wc:UserData> <!-- optional --> <wc:UserDataField name="name">value</wc:UserDataField> . </wc:UserData> </ChargeType>
protected void unmarshallDataArea(org.w3c.dom.Element dataAreaElement)
<DataArea> <Store> <!-- unmarshalled by unmarshallStore() --> . . </Store> <Store> <!-- unmarshalled by unmarshallStore() --> . . </Store> </DataArea>
protected ShippingMode unmarshallShippingMode(org.w3c.dom.Element shippingModeElement, Store newStore)
<ShippingMode> <ModeId>10051</ModeId> <!-- shippingMode.setModeId() --> <ModeDescription>International mail</ModeDescription> <!-- shippingMode.setModeDescription() --> <!-- unmarshalled by unmarshallUserData() --> <wc:UserData> <!-- optional --> <wc:UserDataField name="name">value</wc:UserDataField> . </wc:UserData> </ShippingMode>
protected Role unmarshallRole(org.w3c.dom.Element roleElement, Store newStore)
<Role> <Id>-3</Id> <!-- role.setRoleId() --> <Description>CSR</Description> <!-- role.setDescription() --> <Display>Customer Sales Representative</Display> <!-- role.setDisplay() --> </Role> <Role> <Id>-14</Id> <!-- role.setRoleId() --> <Description>CSR_Sup</Description> <!-- role.setDescription() --> <Display>Customer Sales Representative Supervisor</Display> <!-- role.setDisplay() --> <wc:UserData> <!-- optional --> <wc:UserDataField name="name">value</wc:UserDataField> . </wc:UserData> </Role>
protected void unmarshallStore(Store newStore, org.w3c.dom.Element storeElement)
<Store> <StoreId>10051</StoreId> <!-- store.setStoreId() --> <Description>AdvancedB2BDirect</Description> <!-- store.setDescription() --> <Type>B2B</Type> <!-- store.setType() --> <LanguageId>-1</LanguageId> <!-- store.setLanguageId() --> <SupportedLanguages> <!-- unmarshalled by unmarshallSupportedLanguages --> . . </SupportedLanguages> <AvailShippingModes> <!-- unmarshalled by unmarshallAvailShippingModes --> . . </AvailShippingModes> <ChargeTypes> <!-- unmarshalled by unmarshallChargeTypes --> . . </ChargeTypes> <TicklerCodes> <!-- unmarshalled by unmarshallTicklerCodes --> . . </TicklerCodes> <OverrideReasonCodes> <!-- unmarshalled by unmarshallOverrideReasonCodes --> . . </OverrideReasonCodes> <Roles> <!-- unmarshalled by unmarshallRoles --> . . </Roles> <Owner> <!-- unmarshalled by unmarshallOwner --> . . </Owner> <AllowOrderBlockingInd>true</AllowOrderBlockingInd> <!-- store.setType() --> <SupportedCurrencies> <!-- unmarshalled by unmarshallSupportedCurrencies --> . . </SupportedCurrencies> <wc:UserData> <!-- optional --> <wc:UserDataField name="name">value</wc:UserDataField> . </wc:UserData> </Store>
protected Organization unmarshallOwner(Store newStore, org.w3c.dom.Element ownerElement)
<oa:Owner> <oa:Function>O</oa:Funcstion> <!-- organization.setOrganizationFunction() --> <oa:Name>Business Category</oa:Name> <!-- organization.setCategory() --> <oa:RelatedUnit> <!-- unmarshalled by unmarshallRelatedUnit() --> . . </oa:RelatedUnit> <!-- unmarshalled by unmarshallUserData() --> <wc:UserData> <!-- optional --> <wc:UserDataField name="name">value</wc:UserDataField> . </wc:UserData> </oa:Owner>
protected void unmarshallRelatedUnit(Organization organization, org.w3c.dom.Element relatedUnitElement)
<oa:RelatedUnit> <oa:Unit> <!-- unmarshalled by unmarshallUnit() --> . . </oa:Unit> </oa:RelatedUnit>
protected void unmarshallUnit(Organization organization, org.w3c.dom.Element unitElement)
<oa:Unit> <oa:Id>700000100000009001</oa:Id> <!-- organization.setOrganizationEntityID() --> <oa:Name>Default Organization</oa:Name> <!-- organization.setOrganizationName() --> </oa:Unit>
protected void unmarshallTicklerCodes(org.w3c.dom.Element ticklerCodesElement, Store newStore)
<TicklerCodes> <AvailTicklerActions> <!-- unmarshalled by unmarshallAvailTicklerActions() --> <TicklerActionCode> <TicklerActionId>-1001</TicklerActionId> <ActionCode>TicklerAssign</ActionCode> <Description>Assign tickler</Description> <ClosingActionInd>0</ClosingActionInd> </TicklerActionCode> <TicklerActionCode> <TicklerActionId>-1002</TicklerActionId> <ActionCode>OrderReview</ActionCode> <Description>Review order</Description> <ClosingActionInd>0</ClosingActionInd> </TicklerActionCode> <TicklerActionCode> <TicklerActionId>-1003</TicklerActionId> <ActionCode>OrderBlockResolve</ActionCode> <Description>Resolve blocked order</Description> <ClosingActionInd>1</ClosingActionInd> </TicklerActionCode> </AvailTicklerActions> <AvailTicklerReasons> <!-- unmarshalled by unmarshallAvailTicklerReasons() --> <TicklerReasonCode> <TicklerReasonId>-1001</TicklerReasonId> <ReasonCode>OrderBlocked</ReasonCode> <Description>Order blocked</Description> <SystemDefinedInd>0</SystemDefinedInd> </TicklerReasonCode> <TicklerReasonCode> <TicklerReasonId>-1002</TicklerReasonId> <ReasonCode>OrderBlockedManual</ReasonCode> <Description>Order blocked manually</Description> <SystemDefinedInd>1</SystemDefinedInd> </TicklerReasonCode> <TicklerReasonCode> <TicklerReasonId>-1003</TicklerReasonId> <ReasonCode>OrderBlockedSystem</ReasonCode> <Description>Order blocked by system</Description> <SystemDefinedInd>1</SystemDefinedInd> </TicklerReasonCode> </AvailTicklerReasons> </TicklerCodes>
protected void unmarshallRoles(org.w3c.dom.Element rolesElement, Store newStore)
<Roles> <Role> <!-- unmarshalled by unmarshallRole() --> <Id>-3</Id> <!-- role.setRoleId() --> <Description>CSR</Description> <!-- role.setDescription() --> <Display>Customer Sales Representative</Display> <!-- role.setDisplay() --> </Role> <Role> <Id>-14</Id> <!-- role.setRoleId() --> <Description>CSR_Sup</Description> <!-- role.setDescription() --> <Display>Customer Sales Representative Supervisor</Display> <!-- role.setDisplay() --> </Role> </Roles>
protected void unmarshallAvailTicklerActions(org.w3c.dom.Element availTicklerActionsElement, Store newStore)
<AvailTicklerActions> <TicklerActionCode> <!-- unmarshalled by unmarshallTicklerActionCode() --> <TicklerActionId>-1001</TicklerActionId> <ActionCode>TicklerAssign</ActionCode> <Description>Assign tickler</Description> <ClosingActionInd>false</ClosingActionInd> </TicklerActionCode> <TicklerActionCode> <!-- unmarshalled by unmarshallTicklerActionCode() --> <TicklerActionId>-1002</TicklerActionId> <ActionCode>OrderReview</ActionCode> <Description>Review order</Description> <ClosingActionInd>false</ClosingActionInd> </TicklerActionCode> <TicklerActionCode> <!-- unmarshalled by unmarshallTicklerActionCode() --> <TicklerActionId>-1003</TicklerActionId> <ActionCode>OrderBlockResolve</ActionCode> <Description>Resolve blocked order</Description> <ClosingActionInd>true</ClosingActionInd> </TicklerActionCode> </AvailTicklerActions>
protected TicklerActionCode unmarshallTicklerActionCode(org.w3c.dom.Element ticklerActionCodeElement, Store newStore)
<TicklerActionCode> <TicklerActionId>-1001</TicklerActionId> <!-- ticklerActionCode.setTicklerActionId() --> <ActionCode>TicklerAssign</ActionCode> <!-- ticklerActionCode.setTicklerActionCode() --> <Description>Assign tickler</Description> <!-- ticklerActionCode.setDescription() --> <ClosingActionInd>false</ClosingActionInd> <!-- ticklerActionCode.setClosingActionInd() --> <!-- unmarshalled by unmarshallUserData() --> <wc:UserData> <!-- optional --> <wc:UserDataField name="name">value</wc:UserDataField> . </wc:UserData> </TicklerActionCode>
protected void unmarshallAvailTicklerReasons(org.w3c.dom.Element availTicklerReasonsElement, Store newStore)
<AvailTicklerReasons> <TicklerReasonCode> <!-- unmarshalled by unmarshallTicklerReasonCode() --> <TicklerReasonId>-1001</TicklerReasonId> <ReasonCode>OrderBlocked</ReasonCode> <Description>Order blocked</Description> <SystemDefinedInd>false</SystemDefinedInd> </TicklerReasonCode> <TicklerReasonCode> <!-- unmarshalled by unmarshallTicklerReasonCode() --> <TicklerReasonId>-1002</TicklerReasonId> <ReasonCode>OrderBlockedManual</ReasonCode> <Description>Order blocked manually</Description> <SystemDefinedInd>true</SystemDefinedInd> </TicklerReasonCode> <TicklerReasonCode> <!-- unmarshalled by unmarshallTicklerReasonCode() --> <TicklerReasonId>-1003</TicklerReasonId> <ReasonCode>OrderBlockedSystem</ReasonCode> <Description>Order blocked by system</Description> <SystemDefinedInd>true</SystemDefinedInd> </TicklerReasonCode> </AvailTicklerReasons>
protected TicklerReasonCode unmarshallTicklerReasonCode(org.w3c.dom.Element ticklerReasonCodeElement, Store newStore)
<TicklerReasonCode> <TicklerReasonId>-1001</TicklerReasonId> <!-- ticklerReasonCode.setTicklerReasonId() --> <ReasonCode>OrderBlocked</ReasonCode> <!-- ticklerReasonCode.setTicklerReasonCode() --> <Description>Order blocked</Description> <!-- ticklerReasonCode.setDescription() --> <SystemDefinedInd>false</SystemDefinedInd> <!-- ticklerReasonCode.setSystemDefinedInd() --> <!-- unmarshalled by unmarshallUserData() --> <wc:UserData> <!-- optional --> <wc:UserDataField name="name">value</wc:UserDataField> . </wc:UserData> </TicklerReasonCode>
protected void unmarshallSupportedCurrencies(org.w3c.dom.Element supportedCurrenciesElement, Store newStore)
<SupportedCurrencies> <Currency> <!-- unmarshalled by unmarshallCurrency() --> <CurrencyCode>USD</CurrencyCode> </Currency> </SupportedCurrencies>
protected Currency unmarshallCurrency(org.w3c.dom.Element currencyElement, Store newStore)
<Currency> <!-- Currency.setCurrencyCode() --> <CurrencyCode>USD</CurrencyCode> <!-- unmarshalled by unmarshallUserData() --> <wc:UserData> <!-- optional --> <wc:UserDataField name="name">value</wc:UserDataField> . </wc:UserData> </Currency>
protected void unmarshallSupportedLanguages(org.w3c.dom.Element supportedLanguagesElement, Store newStore)
<SupportedLanguages> <SupportedLanguage>-1</SupportedLanguage> . . <SupportedLanguage>-10</SupportedLanguage> </SupportedLanguages>
protected void unmarshallAvailableReturnReasonsElement(org.w3c.dom.Element reasonsElement, Store store)
<AvailableReturnReasons> <ReturnReason> <ReturnReasonCode>DEF</ReturnReasonCode> <ReturnReasonDescription>Defective product</ReturnReasonDescription> </ReturnReason> </AvailableReturnReasons>
protected void unmarshallAvailableOrderChangeReasonsElement(org.w3c.dom.Element reasonsElement, Store store)
<AvailableOrderChangeReasons> <OrderChangeReason> <OrderChangeReasonCode>DEF</OrderChangeReasonCode> <OrderChangeReasonDescription>Defective product</OrderChangeReasonDescription> <OrderChangeReason> </AvailableOrderChangeReasons>
protected void unmarshallBlockReasonCodes(org.w3c.dom.Element blockReasonCodesElement, Store store)
Note: This method will add the list of Block Reason Codes to the site level.