method ApiGetTranslation

Description

Returns all translations for a specific application object.

Parameters

iiParentObjectID	input	integer	ParentObjectID; ID of the object of which you need the translated description
icNativeString	input	character	Native description of the object, will be returned in case no translation was found.
tTrans	output	temp-table	Temp-table that returns the translations for a single native string.
oiReturnStatus	output	integer	Return status of the method.

Internal usage

unused

program code (program9/btranslation.p)

/* ========================= */
    /* Validate input parameters */
    /* Initialise the output     */
    /* ========================= */
    if iiParentObjectID = 0 or iiParentObjectID = ?
    then do :
        assign oiReturnStatus = -3
               vcMessage      = trim(#T-4'Unable to start the translations. Parent information (ID) is not available.':255(456)T-4#).
        <M-1 run SetMessage
          (input  vcMessage (icMessage), 
           input  '':U (icArguments), 
           input  '':U (icFieldName), 
           input  '':U (icFieldValue), 
           input  'E':U (icType), 
           input  3 (iiSeverity), 
           input  '':U (icRowid), 
           input  'BLF-226':U (icFcMsgNumber), 
           input  '' (icFcExplanation), 
           input  '' (icFcIdentification), 
           input  '' (icFcContext), 
           output viFcReturnSuper (oiReturnStatus)) in BTranslation>
        Return.       
    end. /* if iiParentObjectID = 0 */ 
    empty temp-table tTrans.
    
    /* ============================= */
    /* Retrieve existing information */
    /* ============================= */
    <Q-5 run LanguageByCodeID (all) (Read) (NoCache)
       (input ?, (LngCode)
        input ?, (LngID)
        input ?, (Installed)
        output dataset tqLanguageByCodeID) in BLanguage >
    <Q-2 run TranslationByIDLngParent (all) (Read) (NoCache)
          (input ?, (LngID)
           input iiParentObjectID, (ParentID)
           input ?, (TranslationID)
           output dataset tqTranslationByIDLngParent) in BTranslation >
    
    /* ============================= */
    /* Compose output parameter      */
    /* ============================= */
    for each tqLanguageByCodeID where
             tqLanguageByCodeID.tlLngIsActive = true on error undo, throw:
        create tTrans.
        assign tTrans.tiLngID          = tqLanguageByCodeID.tiLng_ID
               tTrans.tcLngCode        = tqLanguageByCodeID.tcLngCode
               tTrans.tiParentObjectID = iiParentObjectID.
        find tqTranslationByIDLngParent where 
             tqTranslationByIDLngParent.tiParentObject_ID = iiParentObjectID and 
             tqTranslationByIDLngParent.tiLng_ID          = tqLanguageByCodeID.tiLng_ID
             no-lock no-error.
        if available tqTranslationByIDLngParent
        then assign tTrans.tiTranslationStringID   = tqTranslationByIDLngParent.tiTranslationString_ID
                    tTrans.tcTranslationStringText = tqTranslationByIDLngParent.tcTranslationStringText.
        else assign tTrans.tiTranslationStringID   = 0
                    tTrans.tcTranslationStringText = (if icNativeString = ? then "<?>":U else icNativeString).
    end. /* for each tqLanguagePrim */

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 = "BTranslation".
create ttContext.
assign ttContext.propertyName = "methodName"
       ttContext.propertyValue = "ApiGetTranslation".
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/btranslation.apigettranslation.i.xsd", ?).
vhParameter = vhInputDS:get-buffer-handle("tParameterI").
vhParameter:buffer-create().
assign vhParameter::iiParentObjectID = <parameter value>
       vhParameter::icNativeString = <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.