method ApiGLMaskIsValid

Description

ApiGLMaskIsValid; this instance-less method will return if a certain combination of G/L, Division, Project and CostCentre is valid.
As this method does not need and instance, it can be called without starting/stopping an instance (vhFcComponent=?) when you call it from another business-component (not the way an api-method gets called from external applications)

Parameters

iiCompanyId	input	integer	CompanyId of the company you are currently logged on to
iiGLID	input	integer	GLID; when this parameter is filled then the corresponding code-parameter is of no use.
iiDomainID	input	integer	Domain ID
icGLCode	input	character	GLCode; this parameter will only be used if the corresponding ID-parameter is not filled.
iiDivisionID	input	integer	DivisionID; when this parameter is filled then the corresponding code-parameter is of no use.
icDivisionCode	input	character	DivisionCode; this parameter will only be used if the corresponding ID-parameter is not filled.
iiProjectID	input	integer	ProjectID; when this parameter is filled then the corresponding code-parameter is of no use.
icProjectCode	input	character	ProjectCode; this parameter will only be used if the corresponding ID-parameter is not filled.
iiCostCentreID	input	integer	CostCentreID; when this parameter is filled then the corresponding code-parameter is of no use.
icCostCentreCode	input	character	CostCentreCode; this parameter will only be used if the corresponding ID-parameter is not filled.
olValid	output	logical	True if a G/L-Mask combination can be found based on the input parameters.
ocErrorField	output	character	ErrorField; contains the name of the field where no match in GL-Mask could be found, only filled in case olValid = false and the problem was only casued by a single parameter-value). Possible vlaues (untranslatable); GL CC PRJ DIV
ocErrorMessage	output	character	Error Message; contains the error-message in case olValid = false (always filled in this case).
oiReturnStatus	output	integer	Return status of the method.

Internal usage

unused

program code (program8/bglmask.p)

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 = "BGLMask".
create ttContext.
assign ttContext.propertyName = "methodName"
       ttContext.propertyValue = "ApiGLMaskIsValid".
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/bglmask.apiglmaskisvalid.i.xsd", ?).
vhParameter = vhInputDS:get-buffer-handle("tParameterI").
vhParameter:buffer-create().
assign vhParameter::iiCompanyId = <parameter value>
       vhParameter::iiGLID = <parameter value>
       vhParameter::iiDomainID = <parameter value>
       vhParameter::icGLCode = <parameter value>
       vhParameter::iiDivisionID = <parameter value>
       vhParameter::icDivisionCode = <parameter value>
       vhParameter::iiProjectID = <parameter value>
       vhParameter::icProjectCode = <parameter value>
       vhParameter::iiCostCentreID = <parameter value>
       vhParameter::icCostCentreCode = <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.