project QadFinancials > class BPaymentFormat > method ApiDefaultPayFormatCode

Description

This query returns Default payment format codes for a certain payment type


Parameters


icPayFormatTypeCodeinputcharacterPayment format for which you want to get the default data
tPayFormatCodeByDefaultRefoutputtemp-tableThe output temp-table with default payment format codes
oiReturnStatusoutputintegerReturn status of the method.


Internal usage


unused


program code (program3/bpaymentformat.p)

/*input parameters must be specified*/
if icPayFormatTypeCode = "":U or
   icPayFormatTypeCode = "?":U or
   icPayFormatTypeCode = ?
then return.

<Q-1 run PayFormatCodeByDefault (all) (Read) (NoCache)
   (input icPayFormatTypeCode, (PayFormatTypeCode)
    input ?, (PayFormatGroupSequence)
    input true, (PayFormatGroupIsActive)
    input true, (PayFormatCodeIsActive)
    input ?, (PayFormatCodeIsDefault)
    output dataset tqPayFormatCodeByDefault) in BPaymentFormat >
                                 
empty temp-table tPayFormatCodeByDefaultRef.
for each tqPayFormatCodeByDefault 
break by tqPayFormatCodeByDefault.tiPayFormatGroupSequence by tqPayFormatCodeByDefault.tlPayFormatCodeIsDefault desc:
    if first-of (tqPayFormatCodeByDefault.tiPayFormatGroupSequence)
    then do:
        create tPayFormatCodeByDefaultRef.
        assign tPayFormatCodeByDefaultRef.tcPayFormatTypeCode         = tqPayFormatCodeByDefault.tcPayFormatTypeCode
               tPayFormatCodeByDefaultRef.tcPayFormatCode             = if tqPayFormatCodeByDefault.tlPayFormatCodeIsDefault 
                                                                        then tqPayFormatCodeByDefault.tcPayFormatCode
                                                                        else "":U
               tPayFormatCodeByDefaultRef.tcPayFormatCodeDescription  = if tqPayFormatCodeByDefault.tlPayFormatCodeIsDefault 
                                                                        then tqPayFormatCodeByDefault.tcPayFormatCodeDescription
                                                                        else "":U
               tPayFormatCodeByDefaultRef.tiPayFormatGroupSequence    = tqPayFormatCodeByDefault.tiPayFormatGroupSequence
               tPayFormatCodeByDefaultRef.tcPayFormatGroupDescription = tqPayFormatCodeByDefault.tcPayFormatGroupDescription.
    end.
end.


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 = "BPaymentFormat".
create ttContext.
assign ttContext.propertyName = "methodName"
       ttContext.propertyValue = "ApiDefaultPayFormatCode".
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/bpaymentformat.apidefaultpayformatcode.i.xsd", ?).
vhParameter = vhInputDS:get-buffer-handle("tParameterI").
vhParameter:buffer-create().
assign vhParameter::icPayFormatTypeCode = <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.