project QadFinancials > class BExchangeRate > method APIGetExchangeRate

Description

DO NO LONGER CALL THIS METHOD FROM BL-CLASSES - Call method GetExchangeRate in the BL-class itself as this is much more performing.


Parameters


iiFromCurrencyIdinputintegerFrom Currency ID
icFromCurrencyCodeinputcharacterfrom currency code
iiToCurrencyIdinputintegerTo Currency ID
icToCurrencyCodeinputcharacterTo currency code
iiExchangeRateTypeIdinputintegerExchange Rate Type Id
icExchangeRateTypeCodeinputcharacterExchange Rate Type Code
itValidityDateinputdatevalidity date
odMultiplyExchangeRateoutputdecimalExchange Rate (always Multiply)
odExchangeRateScaleFactoroutputdecimalExchange Rate Scle if exists, or the value is "1".
oiReturnStatusoutputintegerReturn status of the method.


Internal usage


QadFinancials
method TConvertInstalNETXML.SetOutputData
method TConvertInstalNETXML.SetOutputDataSub
method BDDocument.AdditionalUpdatesDCollectionCopy


program code (program9/bexchangerate.p)

    
    /* =============================================================================================================== */
    /* Call GetExchangeRate in the ancestor-class                                                                      */
    /* Just pass in the current company - so this method only allows callers to retrieve a rate in the current company */
    /* =============================================================================================================== */
    <M-92 run GetExchangeRate
       (input  viCompanyID (iiCompanyID), 
        input  iiFromCurrencyId (iiFromCurrencyID), 
        input  icFromCurrencyCode (icFromCurrencyCode), 
        input  iiToCurrencyId (iiToCurrencyID), 
        input  icToCurrencyCode (icToCurrencyCode), 
        input  iiExchangeRateTypeId (iiExchangeRateTypeID), 
        input  icExchangeRateTypeCode (icExchangeRateTypeCode), 
        input  itValidityDate (itValidityDate), 
        output odMultiplyExchangeRate (odExchangeRate), 
        output odExchangeRateScaleFactor (odExchangeScaleFactor), 
        output viFcReturnSuper (oiReturnStatus)) in BExchangeRate>
    if viFcReturnSuper <> 0 
    then assign oiReturnStatus = viFcReturnSuper.
    if viFcReturnSuper < 0 
    then Return.
    
    
    
    


Sample code: how to call this method through RPCRequestService (QXtend Inbound)

define temp-table ttContext no-undo
    field propertyQualifier as character
    field propertyName as character
    field propertyValue as character
    index entityContext is primary unique
        propertyQualifier
        propertyName
    index propertyQualifier
        propertyQualifier.

define dataset dsContext for ttContext.

define variable vhContextDS as handle no-undo.
define variable vhExceptionDS as handle no-undo.
define variable vhServer as handle no-undo.
define variable vhInputDS as handle no-undo.
define variable vhInputOutputDS as handle no-undo.
define variable vhOutputDS as handle no-undo.
define variable vhParameter as handle no-undo.

/* Create context */
create ttContext.
assign ttContext.propertyName = "programName"
       ttContext.propertyValue = "BExchangeRate".
create ttContext.
assign ttContext.propertyName = "methodName"
       ttContext.propertyValue = "APIGetExchangeRate".
create ttContext.
assign ttContext.propertyName = "applicationId"
       ttContext.propertyValue = "fin".
create ttContext.
assign ttContext.propertyName = "entity"
       ttContext.propertyValue = "1000".
create ttContext.
assign ttContext.propertyName = "userName"
       ttContext.propertyValue = "mfg".
create ttContext.
assign ttContext.propertyName = "password"
       ttContext.propertyValue = "".

/* Create input dataset */
create dataset vhInputDS.
vhInputDS:read-xmlschema("file", "xml/bexchangerate.apigetexchangerate.i.xsd", ?).
vhParameter = vhInputDS:get-buffer-handle("tParameterI").
vhParameter:buffer-create().
assign vhParameter::iiFromCurrencyId = <parameter value>
       vhParameter::icFromCurrencyCode = <parameter value>
       vhParameter::iiToCurrencyId = <parameter value>
       vhParameter::icToCurrencyCode = <parameter value>
       vhParameter::iiExchangeRateTypeId = <parameter value>
       vhParameter::icExchangeRateTypeCode = <parameter value>
       vhParameter::itValidityDate = <parameter value>.

/* Connect the AppServer */
create server vhServer.
vhServer:connect("-URL <appserver-url>").

if not vhServer:connected()
then do:
    message "Could not connect AppServer" view-as alert-box error title "Error".
    return.
end.

/* Run */
assign vhContextDS = dataset dsContext:handle.

run program/rpcrequestservice.p on vhServer
    (input-output dataset-handle vhContextDS by-reference,
           output dataset-handle vhExceptionDS,
     input        dataset-handle vhInputDS by-reference,
     input-output dataset-handle vhInputOutputDS by-reference,
           output dataset-handle vhOutputDS).

/* Handle output however you want, in this example, we dump it to xml */
if valid-handle(vhExceptionDS)
then vhExceptionDS:write-xml("file", "Exceptions.xml", true).

if valid-handle(vhOutputDS)
then vhOutputDS:write-xml("file", "Output.xml", true).

/* Cleanup */
vhServer:disconnect().
assign vhServer = ?.

if valid-handle(vhInputDS)
then delete object vhInputDS.

if valid-handle(vhOutputDS)
then delete object vhOutputDS.

if valid-handle(vhExceptionDS)
then delete object vhExceptionDS.