project QadFinancials > class BCreditorType > method ApiValidateCreditorType

Description

This procedure is used to validate whether the specific active supplier type exists in the system. If existing, the supplier type description is retrieved.


Parameters


icCreditorTypeinputcharacterThe Supplier Type value to be validated.
ocCreditorTypeDescriptionoutputcharacterreturns the Supplier Type Description
oiReturnStatusoutputintegerReturn status of the method.


Internal usage


unused


program code (program9/bcreditortype.p)

assign oiReturnStatus = -98.

<Q-1 run CreditorTypePrim (all)  (Read)  (NoCache)  (input '', (CreditorTypeID) 
                           input icCreditorType, (CreditorTypeCode)
                           output dataset tqCreditorTypePrim) in BCreditorType >
/* check for availability of creditor type using prim query*/
find first tqCreditorTypePrim no-error.
if not available(tqCreditorTypePrim)
then assign vcMessageText =     #T-6'$1 is not a valid supplier type.':255(59882)t-6#.                
else 
    if not tqCreditorTypePrim.tlCreditorTypeIsActive
    then assign vcMessageText = #T-4'Supplier type $1 is not active.':255(59883)t-4#.             
    else assign ocCreditorTypeDescription = tqCreditorTypePrim.tcCreditorTypeDescription.             

if vcMessageText <> ""
then do:    
    assign oiReturnStatus = -1.
    <M-5 run SetMessage (input  vcMessageText (icMessage), 
                     input  icCreditorType (icArguments), 
                     input  '':U (icFieldName), 
                     input  '':U (icFieldValue), 
                     input  '':U (icType), 
                     input  3 (iiSeverity), 
                     input  '':U (icRowid), 
                     input  'QadFin-4923':U (icFcMsgNumber), 
                     input  '':U (icFcExplanation), 
                     input  '':U (icFcIdentification), 
                     input  '':U (icFcContext), 
                     output viFcReturnSuper (oiReturnStatus)) in BCreditorType>./*set error message for invalid creditor type*/      
    return.
end.
if oiReturnStatus = -98
then assign oiReturnStatus = 0.


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 = "BCreditorType".
create ttContext.
assign ttContext.propertyName = "methodName"
       ttContext.propertyValue = "ApiValidateCreditorType".
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/bcreditortype.apivalidatecreditortype.i.xsd", ?).
vhParameter = vhInputDS:get-buffer-handle("tParameterI").
vhParameter:buffer-create().
assign vhParameter::icCreditorType = <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.